The Roomtype Metadata Audit API ensures the consistency of roomtype metadata pushed from Hotel Trader to the client system. It verifies that the roomtype information stored on the client’s system matches the data sent during the Roomtype Metadata Push.
The audit can be for a single roomtype or all roomtypes of the property.
Appropriate alert messages will be sent to Partner systems after the audit.
Initiator - Hotel Trader
Endpoint
[POST] https://<client-base-url>/roomtype-auditRequest
HTTP Headers
All HTTP headers are mandatory and apply consistently across both endpoints of the API.
Clients must provide their username and password to Hotel Trader. For more information on username and password encoding, please refer to the Authentication page in our Knowledge Base.
| Header Name | Type |
|---|---|
| Content-Type | application/json |
| Accept-Encoding | gzip |
| Authorization | Basic <token> |
Request Description
All the fields in the request are described below.
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | A string that uniquely identifies this particular message. This should be returned in the response. |
| propertyCode | String | Yes | The unique property code of the hotel for which roomtype metadata is requested. |
| roomCodes | Array | No | If present, return only the roomtype with these codes in the response. |
Example
{
"messageId": "haa87gds-6c1d-4e12-b374-c76735b49fc9",
"propertyCode": "NYCMIL",
"roomCodes": null
}Response
Success
All the fields in the response are described below.
Object Description
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | The same messageId string that was sent in the request. |
| status | Object | Yes | The standard status object that describes the success/error status and the error message, if any. |
| propertyCode | String | Yes | The property code that was sent in the request. |
| rooms | Array | No | An array of roomtype objects, which contain the roomtype metadata. |
Example
{
"messageId": "haa87gds-6c1d-4e12-b374-c76735b49fc9",
"status": {
"success": true
},
"propertyCode": "NYCMIL",
"rooms": [
{
"roomName": "Standard King",
"roomCode": "R1FN",
"longDescription": "The RowNYCs guest room and corridor design was led by world renowned architectural and interior design firm, Gensler. New York City’s subway system inspired our vibrant room colors and fun graphic sayings on the walls embrace our perfect Times Square location. All Row NYC guest rooms feature clean, elegant case goods and unexpected details throughout. Witty touches abound, such as the Good Night message visible only when the blackout shades are pulled down. A focal point of our guest rooms is a series of bold custom graphic wall coverings that reference the bright lights and signage of Broadway, and are tempered by a generous use of crisp white and neutrals.",
"shortDescription": "The Standard rooms have an undeniably urban state-of-mind. With the streets beckoning, they are just the right balance of cosmopolitan chill and get-up-and-go.",
"maxAdultOccupancy": 2,
"minAdultOccupancy": 1,
"maxChildOccupancy": 1,
"minChildOccupancy": 0,
"totalMaxOccupancy": 2,
"maxOccupancyForDefaultPrice": 2,
"bedtypes": [
{
"code": "1KB",
"name": "One King Bed"
}
],
"amenities": [
{
"code": "TV",
"name": "Flat-panel TV"
},
{
"code": "AC",
"name": "Air Conditioning"
}
]
},
{
"roomName": "Standard Queen",
"roomCode": "Q1",
"longDescription": "The Queen rooms have an undeniably urban state-of-mind. With the streets beckoning, they are just the right balance of cosmopolitan chill and get-up-and-go. The RowNYCs guest room and corridor design was led by world renowned architectural and interior design firm, Gensler. New York City’s subway system inspired our vibrant room colors and fun graphic sayings on the walls embrace our perfect Times Square location. All Row NYC guest rooms feature clean, elegant case goods and unexpected details throughout. Witty touches abound, such as the Good Night message visible only when the blackout shades are pulled down. A focal point of our guest rooms is a series of bold custom graphic wall coverings that reference the bright lights and signage of Broadway, and are tempered by a generous use of crisp white and neutrals.",
"shortDescription": "The Queen rooms have an undeniably urban state-of-mind. With the streets beckoning, they are just the right balance of cosmopolitan chill and get-up-and-go.",
"maxAdultOccupancy": 2,
"minAdultOccupancy": 1,
"maxChildOccupancy": 1,
"minChildOccupancy": 0,
"totalMaxOccupancy": 2,
"maxOccupancyForDefaultPrice": 2,
"bedtypes": [
{
"code": "1QB",
"name": "One Queen Bed"
}
],
"amenities": [
{
"code": "TV",
"name": "Flat-panel TV"
},
{
"code": "AC",
"name": "Air Conditioning"
}
]
}
]
}
Error
This API follows the Standard Response model of the Content API for error responses.