Set Bathroom (Create and Update)
This endpoint is used to manage bathroom details for different types of properties—hotel, hostel, and home. This API allows you to set, update, remove, or retrieve bathroom details for the rooms in a given hotel, hostel, or home.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/room/bathroom/setHeader
-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)
Specifies the hotel ID for the property.
channel_hotel_id string (Required)
Specifies the channel-specific hotel ID for the property.
channel_room_id string (Required)
Specifies the unique identifier for the room in the channel's system.
hotel_bathroom_details object (Optional)
Container for hotel-type bathroom details.
shared_bathroom_state string (Required
Indicates if shared bathroom is available.
private_bathroom_state string (Required)
Indicates if private bathroom is available.
private_bathroom_details object (Optional)
Container for private bathroom details.
type string (Optional)
Specifies the type of private bathroom.
location_type string (Optional)
Specifies the location of private bathroom.
location_other string (Optional)
Specifies the custom location description.
property_bathroom_details object (Optional)
Container for property-type bathroom details.
bathrooms array (Required)
Contains a list of bathroom configurations.
bathroom_type string (Required)
Specifies if bathroom is private or shared.
bathroom_location string (Optional)
Specifies the location of the bathroom.
hostel_bathroom_details object (Optional)
Contains hostel-specific bathroom details.
gender string (Optional)
Specifies the gender designation for the bathroom.
num_guests_with_access_type string (Optional)
Specifies the number of guests with access.
bathroom_facilities array (Required)
Specifies the list of facilities in the bathroom.
type string (Required)
Specifies the type of facility.
count integer (Optional)
Specifies the number of this facility type.
is_paid boolean (Optional)
Specifies whether the facility is paid.
number_of_bathrooms integer (Required)
Specifies the total number of bathrooms.
Sample Request
To set Bathroom for Hotel
{
"hotel_id": "new1",
"channel_hotel_id": "12915674",
"channel_room_id": "1291567405",
"hotel_bathroom_details": {
"shared_bathroom_state": "PRESENT",
"private_bathroom_state": "PRESENT",
"private_bathroom_details": {
"type": "EXTERNAL_BATHROOM",
"location_type": "OTHER",
"location_other": "outside of the room"
},
"number_of_bathrooms": 1
}
}To set Bathroom for Home
{
"hotel_id": "new1",
"channel_hotel_id": "12915674",
"channel_room_id": "1291567403",
"property_bathroom_details": {
"bathrooms": [
{
"bathroom_type": "PRIVATE",
"bathroom_location": "INSIDE_THE_ROOM"
},
{
"bathroom_type": "SHARED",
"bathroom_location": "OPPOSITE_THE_ROOM"
},
{
"bathroom_type": "SHARED",
"bathroom_location": "INSIDE_OR_ATTACHED_TO_BEDROOM"
}
]
}
}To set Bathroom for Hostel
{
"hotel_id": "new1",
"channel_hotel_id": "12915674",
"channel_room_id": "1291567405",
"property_bathroom_details": {
"bathrooms": [
{
"bathroom_type": "SHARED",
"bathroom_location": "DOWN_THE_HALL",
"hostel_bathroom_details": {
"gender": "MIXED",
"num_guests_with_access_type": "NUMBER_LESS_THAN_5",
"bathroom_facilities": [
{
"type": "SHOWER",
"count": 98
},
{
"type": "TOILET",
"count": 1
},
{
"type": "SINK",
"count": 68
},
{
"type": "BATH",
"count": 16
},
{
"type": "TOILET_PAPER"
},
{
"type": "HAIR_DRYER"
},
{
"type": "SLIPPERS",
"is_paid": true
},
{
"type": "BIDET"
},
{
"type": "TOOTHBRUSH",
"is_paid": true
},
{
"type": "SHAMPOO",
"is_paid": false
},
{
"type": "CONDITIONER",
"is_paid": false
},
{
"type": "BODY_SOAP",
"is_paid": true
},
{
"type": "TOWEL",
"is_paid": false
},
{
"type": "HOT_WATER"
}
]
}
},
{
"bathroom_type": "SHARED",
"bathroom_location": "DOWN_THE_HALL",
"hostel_bathroom_details": {
"gender": "MIXED",
"num_guests_with_access_type": "NUMBER_LESS_THAN_5",
"bathroom_facilities": [
{
"type": "SHOWER",
"count": 98
},
{
"type": "TOILET",
"count": 21
},
{
"type": "SINK",
"count": 68
},
{
"type": "BATH",
"count": 16
},
{
"type": "TOILET_PAPER"
},
{
"type": "HAIR_DRYER"
},
{
"type": "SLIPPERS",
"is_paid": true
},
{
"type": "BIDET"
},
{
"type": "TOOTHBRUSH",
"is_paid": true
},
{
"type": "SHAMPOO",
"is_paid": false
},
{
"type": "CONDITIONER",
"is_paid": false
},
{
"type": "BODY_SOAP",
"is_paid": true
},
{
"type": "TOWEL",
"is_paid": true
},
{
"type": "HOT_WATER"
}
]
}
},
{
"bathroom_type": "PRIVATE",
"bathroom_location": "ENSUITE",
"hostel_bathroom_details": {
"bathroom_facilities": [
{
"type": "SHOWER",
"count": 98
},
{
"type": "TOILET",
"count": 21
},
{
"type": "SINK",
"count": 68
},
{
"type": "BATH",
"count": 16
},
{
"type": "TOILET_PAPER"
},
{
"type": "HAIR_DRYER"
},
{
"type": "SLIPPERS",
"is_paid": true
},
{
"type": "BIDET"
},
{
"type": "TOOTHBRUSH",
"is_paid": true
},
{
"type": "SHAMPOO",
"is_paid": false
},
{
"type": "CONDITIONER",
"is_paid": false
},
{
"type": "BODY_SOAP",
"is_paid": true
},
{
"type": "TOWEL",
"is_paid": true
},
{
"type": "HOT_WATER"
}
]
}
}
]
}
}Response
Sample Success Response - Hotel/Home/Hostel
{
"Status": "Success",
"Data": [],
"Message": "Bathroom Details Set Successfully",
"Ruid": "357840d8-b3c3-4798-a136-34a838d46e6a"
}Success Response Body Elements
Status string
Indicates the result of the API call.
Data object
An object containing data related to the successful image creation. This typically includes identifiers for the created images.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid string
Specifies the unique request ID.
Errors
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": "Invalid value: roomId not found",
"Ruid": "2deb6eb5-5223-4a15-ba6a-697fc3ec13eb"
}Sample Error Response 4
{
"Status": "Fail",
"Errors": [
{
"Code": "828",
"ShortText": "bathrooms: bathroom_type is invalid"
}
],
"Message": "",
"Ruid": ""
}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?