Retrieve Bathroom

This page explains Request and Response for retrieving bathrooms.


Endpoint

POST

Header
Type
Required
Description

app-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.


Sample Request


Response

Sample Success Response - 1

circle-info

Below response example contains home type property bathrooms.

Sample Success Response - 2

When there is no bathroom details found then you will get below response:

Success Response Body Elements

Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.


Data object

An object containing data related to the successful image creation. This typically includes identifiers for the created images.

property_bathroom_details object

Contains bathroom details for property-type rooms.

bathrooms array

Contains a list of bathroom configurations.

circle-info

Maximum 20 bathrooms

id integer A unique identifier for the bathroom.

bathroom_type string

Specifies if bathroom is private or shared.

circle-info

Required. Supports: PRIVATE, SHARED

bathroom_location string

Specifies the location of the bathroom.

circle-info

Supports: ENSUITE, NEXT_DOOR, DOWN_THE_HALL, OPPOSITE_THE_ROOM, IN_THE_HALLWAY, OTHER, INSIDE_THE_APARTMENT, INSIDE_OR_ATTACHED_TO_BEDROOM, INSIDE_THE_ROOM


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.

circle-info

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

Errors

Sample Error Response 1

Sample Error Response 2


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.

circle-info

For example: "400" indicates a bad request.

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?