Get Connection Request
This API endpoint allows clients to retrieve connection request details for a specific hotel property.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/connection/getConnectionRequest Header
-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 1
Retrieve Connection Request Details For Specific Property
{
"hotel_id": "new1",
"channel_hotel_id": "12915674"
}Response
Attributes
Status string
Indicates the result of the API call.
Data object
Contains the main response data, such as property connection details.
Data.connection_request_data[] array
List of connection request records for properties.
connection_request_data.legal_entity object
Details of the legal entity managing the property.
legal_entity.id integer
Unique identifier of the legal entity.
legal_entity.company_name string
Name of the company or legal entity associated with the property.
connection_request_data.connection_types[] array of strings
Types of integrations requested for the connection.
connection_request_data.requested_at string
Timestamp when the connection request was submitted.
connection_request_data.property object
Information about the property.
property.country_code string
Code representing the property's country.
property.zip_code string
Postal code of the property's location.
property.id integer
Unique identifier of the property in the system.
property.name string
Name of the hotel or property.
property.city string
City where the property is located.
property.address string
Street address of the property.
connection_request_data.pricing object
Contains pricing model details.
pricing.currency_code string
Currency used by the property.
pricing.model string
Pricing model configured for the property.
Message string
Descriptive message summarizing the API operation's outcome.
Ruid string
Unique request identifier for tracking, debugging, and logging.
Sample Success Response
{
"Status": "Success",
"Data": {
"connection_request_data": [
{
"legal_entity": {
"id": 12345,
"company_name": "XYZ Test Inc"
},
"connection_types": [
"RESERVATIONS",
"AVAILABILITY",
"PHOTOS"
],
"requested_at": "2023-08-07T10:40:54Z",
"property": {
"country_code": "nl",
"zip_code": "1018 VL",
"id": 8011855,
"name": "HillTop Hotel",
"city": "Amsterdam",
"address": "Nieuwe straat 157"
},
"pricing": {
"currency_code": "EUR",
"model": "Standard"
}
}
]
},
"Message": "Connection Request Details Fetch Successfully",
"Ruid": "3958a40e-3fe3-45ea-87e4-9e508498c756"
}Success Response 2
{
"Status": "Success",
"Data": [],
"Message": "No Data Found",
"Ruid": "3958a40e-3fe3-45ea-87e4-9e508498c756"
}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
{
"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 Connection Request Details For Any Property
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.
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 Connection Request Details For Any Property
{
"parameters": {
"start_time": "2024-01-07T10:00:00Z",
"end_time": "2025-01-07T10:00:00Z",
"connection_type": "AVAILABILITY",
"missing_connection_type": "AVAILABILITY",
"page_size": 1,
"order_by": "requested_at asc"
}
}Response
Attributes
Status string
Indicates the outcome of the API request. Expected value: Success.
Data object
Contains the primary payload of the response. May include an array of connection request records or be empty if no data is found.
Data.connection_request_data array
An array containing individual connection request records. If no data exists, this will be an empty array.
Each object within connection_request_data contains:
legal_entity.id integer
Unique identifier of the legal entity associated with the property.
legal_entity.company_name string
Official name of the company or legal entity managing the property.
connection_types array of string
List of requested or supported connection types.
requested_at string
Timestamp indicating when the connection request was made.
property.country_code string
Country code of the property's location.
property.zip_code string
Postal or ZIP code of the property's address.
property.id integer
Unique identifier of the property in the system.
property.name string
Name of the property or hotel.
property.city string
City where the property is located.
property.address string
Full street address of the property.
pricing.currency_code string
Currency used by the property.
pricing.model string
Pricing strategy or model adopted by the property.
Message string
Human-readable description of the response outcome.
Ruid string
Unique identifier used for request tracing, logging, and debugging.
Sample Success Response
{
"Status": "Success",
"Data": {
"connection_request_data": [
{
"legal_entity": {
"id": 22345,
"company_name": "XYZ Test Inc"
},
"connection_types": [
"RESERVATIONS",
"AVAILABILITY",
"PHOTOS"
],
"requested_at": "2023-08-07T10:40:54Z",
"property": {
"country_code": "nl",
"zip_code": "1018 VL",
"id": 8011855,
"name": "HillTop Hotel",
"city": "Amsterdam",
"address": "Nieuwe straat 157"
},
"pricing": {
"currency_code": "EUR",
"model": "Standard"
}
}
],
"other_data": {
"Next_Count": 0,
"Previous_Count": 0
}
},
"Message": "Connection Request Details Fetch Successfully",
"Ruid": "f4ef89ae-9de1-4eaa-bf74-10c05459b1f5"
}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?