Retrieve Set Facility of Property and Room
This endpoint retrieves the facilities associated with a property or a specific room. It can fetch facility details for both the property level (for example, parking, restaurant) and the room level (for example, minibar, internet) based on the provided hotel_id and channel_hotel_id. If a specific room's facilities are requested, the channel_room_id is also required.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/facilities/retrieveHeader
-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. for authorization. Required for authentication.
Content-Type
string
Yes
Must be set to application/json.
Attributes
hotel_id string (Required)
The unique property ID as assigned by the provider upon creation of the property.
channel_hotel_id string (Required)
The unique id for the hotel on the specific channel.
channel_room_id string (Required)
A unique identifier for the room within the specific channel (for example, a property management system or booking platform). This ID allows the system to identify and update the facilities for a particular room in the hotel.
Sample Request
Request Body to Retrieve Property Level Facility
{
"hotel_id": "new1",
"channel_hotel_id": "12915674"
}Request Body to Retrieve Room Level Facility
{
"hotel_id": "new1",
"channel_hotel_id": "12915674",
"channel_room_id": "55555"
}Response
Sample Success Response - Property Level
{
"Status": "Success",
"Data": [
{
"facility_id": 96,
"is_available": true,
"instances": []
},
{
"facility_id": 160,
"is_available": true,
"instances": []
},
{
"facility_id": 161,
"is_available": true,
"instances": []
},
{
"facility_id": 2,
"is_available": true,
"instances": [
{
"instance_id": 95879415,
"parking_details": {
"name": "Basement2 Parking",
"parking_type": "UNKNOWN_PARKING_TYPE",
"parking_location": "ON_SITE",
"parking_access": "ONLY_GUESTS",
"parking_reservation": "NOT_NEEDED",
"max_height_m": 0,
"has_valet_service": "NOT_SPECIFIED",
"has_onsite_staff": "NOT_SPECIFIED",
"has_gated_parking": "NOT_SPECIFIED",
"has_security_cameras": "NOT_SPECIFIED",
"has_ev_charging_station": "NOT_SPECIFIED",
"has_accessible_parking_spots": "NOT_SPECIFIED"
},
"payment_details": {
"charge_mode": "FREE"
}
}
]
},
{
"facility_id": 8,
"is_available": true,
"instances": []
},
{
"facility_id": 9,
"is_available": true,
"instances": [
{
"on_site_details": {
"onsite_type": "DEFAULT"
},
"surcharge_details": {
"surcharge_type": "DEFAULT"
}
}
]
},
{
"facility_id": 11,
"is_available": true,
"instances": [
{
"schedule_details": {
"schedule": [
{
"from": {
"hours": 23,
"minutes": 58
},
"to": {
"hours": 23,
"minutes": 59
},
"day_of_week": "SUNDAY"
}
]
}
}
]
},
{
"facility_id": 107,
"is_available": true,
"instances": []
},
{
"facility_id": 301,
"is_available": true,
"instances": []
},
{
"facility_id": 46,
"is_available": true,
"instances": []
}
],
"Message": "Facility Data Fetched Successfully",
"Ruid": "94fff2fd-aa61-4507-8682-57b6f7026b7b"
}Sample Success Response - Room Level
{
"Status": "Success",
"Data": [
{
"facility_id": 96,
"is_available": true,
"instances": []
},
{
"facility_id": 160,
"is_available": true,
"instances": []
},
{
"facility_id": 161,
"is_available": true,
"instances": []
},
{
"facility_id": 2,
"is_available": true,
"instances": [
{
"instance_id": 95879415,
"parking_details": {
"name": "Basement2 Parking",
"parking_type": "UNKNOWN_PARKING_TYPE",
"parking_location": "ON_SITE",
"parking_access": "ONLY_GUESTS",
"parking_reservation": "NOT_NEEDED",
"max_height_m": 0,
"has_valet_service": "NOT_SPECIFIED",
"has_onsite_staff": "NOT_SPECIFIED",
"has_gated_parking": "NOT_SPECIFIED",
"has_security_cameras": "NOT_SPECIFIED",
"has_ev_charging_station": "NOT_SPECIFIED",
"has_accessible_parking_spots": "NOT_SPECIFIED"
},
"payment_details": {
"charge_mode": "FREE"
}
}
]
},
{
"facility_id": 8,
"is_available": true,
"instances": []
},
{
"facility_id": 9,
"is_available": true,
"instances": [
{
"on_site_details": {
"onsite_type": "DEFAULT"
},
"surcharge_details": {
"surcharge_type": "DEFAULT"
}
}
]
},
{
"facility_id": 11,
"is_available": true,
"instances": [
{
"schedule_details": {
"schedule": [
{
"from": {
"hours": 23,
"minutes": 58
},
"to": {
"hours": 23,
"minutes": 59
},
"day_of_week": "SUNDAY"
}
]
}
}
]
},
{
"facility_id": 107,
"is_available": true,
"instances": []
},
{
"facility_id": 301,
"is_available": true,
"instances": []
},
{
"facility_id": 46,
"is_available": true,
"instances": []
}
],
"Message": "Facility Data Fetched Successfully",
"Ruid": "94fff2fd-aa61-4507-8682-57b6f7026b7b"
}Success Response Body Elements
Indicates the result of the API call.
Data array
The Data array contains a list of facilities associated with either the property or the room, depending on the request.
Each facility object in the array contains the following:
facility_id integer
A unique identifier for the facility.
is_available boolean
A boolean flag indicating whether the facility is available (true if available, false otherwise).
instances array
An array that contains any specific instances or details related to the facility. For example, parking facilities may include specific parking instance details such as parking type, location, and payment information. If there are no specific instances for a facility, the array will be empty.
Message string
Provides a brief message about the outcome. Here, it states "Successfully fetch details," confirming that the requested information was retrieved.
Ruid string
A unique identifier for tracking the request.
Errors
Sample Error Response 1
{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail",
"Ruid": ""
}Sample Error Response 2
{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail",
"Ruid": ""
}Sample Error Response 3
{
"Status": "Fail",
"Errors": [],
"Message": "Access denied",
"Ruid": "xxxxxx"
}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?