Get Active Connection
This endpoint is used to retrieve active connection details for a specific hotel property or multiple properties across the system.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/connection/getActiveConnectionHeader
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/jsonapp-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key required for authorization.
Content-Type
string
Yes
Must be set to application/json.
Attributes
hotel_id string (Required)
Specifies the hotel ID for the property.
channel_hotel_id string (Required)
Specifies the channel-specific hotel ID for the property.
Sample Request
{
"hotel_id": "new1",
"channel_hotel_id": "12915674"
}Response
Attribute
Status string
Indicates the result of the API call. Value will be Success for successful responses.
Data object
Contains the response payload, including connection and pagination information.
Data.active_connection_data array of object
List of active connections returned for the requested property or properties. If no active connections exist, this field may be omitted or empty.
legal_entity.id integer
Unique identifier of the legal entity associated with the connection.
legal_entity.company_name string
Name of the legal entity or company managing the property.
connection_types object
A key-value pair where each key represents a connection type.
connected_at string
Timestamp representing when the connection was first established.
last_connected_at string
Timestamp representing the most recent time the connection was successfully established.
property.id integer
Unique identifier for the property.
property.name string
Name of the property.
property.city string
City where the property is located.
property.address string
Full address of the property.
property.country_code string
Country code for the property's location.
property.zip_code string
Postal or ZIP code for the property's location.
pricing.model string
Pricing strategy used by the property.
pricing.currency_code string
Currency code used for pricing.
Data.other_data object
Contains metadata for pagination purposes.
other_data.Next_Count integer
Indicates how many more records exist after the current page.
other_data.Previous_Count integer
Indicates how many records existed before the current page.
Message string
Descriptive message detailing the result of the API request.
Ruid string
A unique identifier for the request, used for tracking and debugging.
Sample Success Response 1
{
"Status": "Success",
"Data": {
"active_connection_data": [
{
"legal_entity": {
"id": 78775,
"company_name": "BH MPP Performance Test account 1"
},
"connection_types": {
"REVIEWS": "2024-10-09T04:57:27Z",
"CONTENT": "2024-10-09T04:57:27Z",
"REPORTING": "2024-10-09T04:57:27Z",
"RESERVATIONS": "2024-10-09T04:57:27Z",
"PERFORMANCE": "2024-10-09T04:57:27Z",
"MESSAGING": "2024-10-09T04:57:27Z",
"AVAILABILITY": "2024-10-09T04:57:27Z",
"PHOTOS": "2024-10-09T04:57:27Z"
},
"connected_at": "2024-10-09T04:57:27Z",
"last_connected_at": "2024-10-09T04:57:27Z",
"property": {
"id": 12915674,
"name": "Home Property Apartment",
"city": "Surat",
"address": "Adajan",
"country_code": "in",
"zip_code": "395009"
},
"pricing": {
"model": "Standard",
"currency_code": "INR"
}
}
],
"other_data": {
"Next_Count": 0,
"Previous_Count": 0
}
},
"Message": "Active Connection Request Details Fetch Successfully",
"Ruid": "59f847d7-a657-4584-9806-99a86019f61a"
}Success Response 2
{
"Status": "Success",
"Data": {
"other_data": {
"Next_Count": 0,
"Previous_Count": 0
}
},
"Message": "No Data Found",
"Ruid": "f4ef89ae-9de1-4eaa-bf74-10c05459b1f5"
}Error
Sample Error Response 1
{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail"
}Sample Error Response 2
{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail"
}Sample Error Response 3
When error was thrown from booking.com
{
"Status": "Fail",
"Errors": [],
"Message": "Access denied"
}Error Response Body Elements
Status string
Indicates the result of the API call, which will be always Fail in case of an error response.
Error array
Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Ruid string
A unique identifier for tracking the request.
Sample Request 2
Retrieve Active Connection Details For All Properties
Attributes
start_time string (Required)
Defines the beginning of the time range for fetching connection data.
end_time string (Optional)
Filters results to include properties with the specified connection type.
connection_type string (Optional)
Filters results to include properties with the specified connection type.
missing_connection_type string (Optional)
Filters results to include only properties missing the specified connection type.
cursor string (Optional)
Cursor token for pagination. Used to fetch the next/previous set of results.
page_size integer (Optional)
Specifies the maximum number of records to return in one page. Useful for paginated responses.
order_by string (Optional)
Defines the sorting order of the results.
Retrieve Active Connection Details For All Properties
{
"parameters": {
"start_time": "2024-01-07T10:00:00Z",
"end_time": "2025-01-07T10:00:00Z",
"connection_type": "AVAILABILITY",
"missing_connection_type": "AVAILABILITY",
"cursor": "AAAMNOBoyhgCBCAAAGIfgOE",
"page_size": 1,
"order_by": "connected_at asc"
}
}Response
Sample Success Response
Status string
Indicates the result of the API call. Value will be Success for successful responses.
Data object
Contains the response payload, including connection and pagination information.
Data.active_connection_data array of object
List of active connections returned for the requested property or properties. If no active connections exist, this field may be omitted or empty.
legal_entity.id integer
Unique identifier of the legal entity associated with the connection.
legal_entity.company_name string
Name of the legal entity or company managing the property.
connection_types object
A key-value pair where each key represents a connection type.
connected_at string
Timestamp representing when the connection was first established.
last_connected_at string
Timestamp representing the most recent time the connection was successfully established.
property.id integer
Unique identifier for the property.
property.name string
Name of the property.
property.city string
City where the property is located.
property.address string
Full address of the property.
property.country_code string
Country code for the property's location.
property.zip_code string
Postal or ZIP code for the property's location.
pricing.model string
Pricing strategy used by the property.
pricing.currency_code string
Currency code used for pricing.
Data.other_data object
Contains metadata for pagination purposes.
other_data.Next_Count integer
Indicates how many more records exist after the current page.
other_data.Previous_Count integer
Indicates how many records existed before the current page.
Message string
Descriptive message detailing the result of the API request.
Ruid string
A unique identifier for the request, used for tracking and debugging.
Sample Success Response 1
{
"Status": "Success",
"Data": {
"active_connection_data": [
{
"legal_entity": {
"id": 1742698,
"company_name": "Zen Johnson"
},
"connection_types": {
"REVIEWS": "2024-01-08T06:06:46Z",
"CONTENT": "2024-01-08T06:06:46Z",
"REPORTING": "2024-01-08T06:06:46Z",
"RESERVATIONS": "2024-01-08T06:06:46Z",
"MESSAGING": "2024-01-08T06:06:46Z",
"AVAILABILITY": "2024-01-08T06:06:46Z",
"PHOTOS": "2024-01-08T06:06:46Z"
},
"connected_at": "2024-01-08T06:06:46Z",
"last_connected_at": "2024-01-08T06:06:46Z",
"property": {
"id": 9283925,
"name": "KRISHNAGIRI homes",
"city": "Guruvayur",
"address": "Krishnagiri Homes, Parath Lane, Mammiyur, Guruvayur, Thrissur, Kerala.",
"country_code": "in",
"zip_code": "680103"
},
"pricing": {
"model": "Standard",
"currency_code": "INR"
}
}
],
"other_data": {
"Next_Count": 3171,
"Previous_Count": 0
}
},
"Message": "Active Connection Request Details Fetch Successfully",
"Ruid": "164ed721-b38e-42a9-8f26-ffcc0a4d9be4"
}Success Response 2
{
"Status": "Success",
"Data": {
"other_data": {
"Next_Count": 0,
"Previous_Count": 0
}
},
"Message": "No Data Found",
"Ruid": "f4ef89ae-9de1-4eaa-bf74-10c05459b1f5"
}Error
Sample Error Response 1
When error was thrown from booking.com
{
"Status": "Fail",
"Errors": [],
"Message": "Access denied"
}Error Response Body Elements
Status string
Indicates the result of the API call, which will be always "Fail" in case of an error response.
Error array
Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Ruid string
A unique identifier for tracking the request.
Last updated
Was this helpful?