Hotel Metadata Audit API

The Hotel Metadata Audit API serves to verify the accuracy and consistency of property metadata pushed from Hotel Trader to the client.

Initiator - Hotel Trader

Endpoint

[POST] https://<client-base-url>/hotel-audit

Request

HTTP Headers

All the HTTP Headers are mandatory. These headers are applicable and remain the same for both end-points of the Hotel Audit API.


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 metadata is requested.

Example

{
"messageId": "hhw87gds-6c1d-4e12-b374-c76735b49fc9",
"propertyCode": "NYCMIL",
}

Response

Success

Object description

The response object here is the same as the request object in the Hotel Metadata Push API.

Field/Object Datatype Required Description
messageId String Yes The same messageId string that is sent in the request.
status Object Yes The unique property code of the hotel for which metadata is requested.
hotel
ObjectYesThe hotel object contains all the metadata, as stored on the client’s system.

Example

{
    "messageId": "hhw87gds-6c1d-4e12-b374-c76735b49fc9",
    "status": {
        "success": true
    },
    "hotel": {
        "code": "NYCMIL",
        "name": "Row NYC",
        "mappingProvider": "GIATA",
        "mappingCode": "GIATACODE",
        "starRating": 4,
        "defaultCurrencyCode": "USD",
        "maxRoomsBookable": 9,
        "numberOfRooms": 130,
        "numberOfFloors": 8,
        "addressLine1": "701 9th Avenue",
        "addressLine2": null,
        "city": "New York",
        "state": "New York",
        "stateCode": "NY",
        "country": "United States of America",
        "countryCode": "US",
        "zip": 55555,
        "phone1": "15521869-3600",
        "phone2": "11221121",
        "fax1": "11244-0644",
        "fax2": "22342-1123",
        "websiteUrl": "www.rownyc.com",
        "longitude": "-73.98857859999998",
        "latitude": "40.7588237",
        "longDescription": "Dummy long description",
        "shortDescription": "Dummy short description",
        "checkInPolicy": "check-in policy text",
        "checkInTime": "12:30",
        "checkOutTime": "11:00",
        "adultAge": 14,
        "timeZone": "America/New_York",
        "defaultLanguage": "en",
        "adultOnly": false,
        "currencies": [
            {
                "code": "USD",
                "name": "United States Dollar"
            }
        ],
        "languages": [
            {
                "code": "EN",
                "name": "English"
            }
        ],
        "creditCardTypes": [
            {
                "code": "VS",
                "name": "Visa"
            },
            {
                "code": "MC",
                "name": "MasterCard"
            },
            {
                "code": "AX",
                "name": "American Express"
            }
        ],
        "bedtypes": [
            {
                "code": "TDBL",
                "name": "Two Double Beds"
            },
            {
                "code": "1FB",
                "name": "One Full Bed"
            },
            {
                "code": "TWB",
                "name": "Two Twin Beds"
            }
        ],
        "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 the error response.