Search by Location API Reference

PropertiesResponse

Top level object for response.

Includes Properties and CurrencyRateConversion objects.

---

Properties

Top level object that includes pagination information for properties list.

Properties:

totalProperties: The total number of properties returned in the search.

propertiesPerPage: The number of properties returned in the current page (max 25 per page).

numberOfPages: The total number of pages that can returned in the search.

Includes Identifier and PropertyInfo objects.

---

Identifier

A key that can be used to retrieve additional pages of properties.

Properties:

value: An identifier to be sent in any subsequent Pagination request.

---

PropertyInfo

Each instance of PropertyInfo provides all information returned about one property

Properties:

availability: Indicates whether the property has rooms available for the requested dates; possible values are:

• Open: Property has rooms/rates available that match search parameters.

• Other: Property has rooms/rates available that do not match search parameters.

• Close: Property has no rooms available.

id: Property identifier composed of the chain and property codes.

featuredPropertyInd: Indicates if a property has been promoted to the top of the Properties list through the featured properties program. Featured properties always have this indicator and are sorted at the top of the list when searching by IATA city/airport codes.

Includes Identifier, Distance, Property, and LowestAvailableRate objects.

---

Identifier

Defines which supplier system returned the lowest available rate for that property.

Properties:

authority: Indicates which supplier returned the lowest available rate for that property. Supported values are:

• TVPT: Travelport

• BKNG: Booking.com

---

Distance

The distance from the specified search location. Properties:

unitofDistance: The unit of distance for the search radius around the specified location. Possible values are Miles and Kilometers. If unitOfDistance is not specified in the request, the search defaults to searching in miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.

value: The distance from the specified search location.

---

Property

Properties:

name: Text string for the name of the property.

id: Property ID composed of the chain and property codes.

Includes PropertyKey, Rating, GeoLocation, Image, and Address objects.

---

PropertyKey

Property chain code and property code.

Properties:

chainCode: Two-character code for the chain.

propertyCode: Code for the property within the hotel chain.

---

Rating

A hotel rating from NTM. Properties:

provider: Rating source.

value: Rating value.

---

GeoLocation

Geographic coordinates of the property.

Properties:

latitude: The numeric latitude of the property.

longitude: The numeric longitude of the property.

---

Image

A link to an image for the property.

Properties:

dimensionCategory : Image size category. Possible values are:

• S: Small

• M: Medium

• T: Thumbnail

• L: Large

• E: ExtraLarge

width: Image width in pixels.

height: Image height in pixels.

caption: Image caption up to 128 characters.

pictureCategory: The image category number. Possible values are:

• 1: exterior

• 2: lobby

• 3: pool

• 4: restaurant

• 5: health club

• 6: guestroom

• 7: suite

• 8: conference room

• 9: ballroom

• 10: golf

• 11: beach

• 12: spa

• 13: bar

• 14: recreational

• 21: room amenity

• 22: property amenity

• 23: business center

value: A link to an image for the property.

---

Address

The property address information.

Properties:

AddressLine: An array of strings for street address. Each element of the array represents an address line.

City: The full city name of the property address.

PostalCode: The postal code or zip code of the property address.

Includes StateProv and Country objects.

---

StateProv

Properties:

value: The state or providence code of the property address.

---

Country

Properties:

name: The full name of the property address's country.

value: The country code of the property address

---

PropertyAmenity

An array of amenities such as type of breakfast, spa, and pool.

Properties:

description: Type of amenity.

code: OTA code for amenity

---

LowestAvailableRate

The hotel's lowest available rate for the property for the requested dates.

Properties:

code: Code for the currency the rate is returned in.

value: Amount of lowest available rate.

---

MaximumAvailableRate

The hotel's maximum available rate for the property for the requested dates.

Properties:

code: Code for the currency in which the rate is returned.

value: Amount of maximum available rate.

authority: Indicates which supplier returned the maximum available rate for that property. Supported values are:

• TVPT: Travelport

• EXPE: Expedia

• BKNG: Booking.com

---

CurrencyRateConversion

CurrencyRateConversion is returned only if requestedCurrency was sent in the request.

By default the Hotel APIs return all rates in the currency of the hotel's location. If requestedCurrency was sent in the request, the response returns currency conversion information per below.

Includes SourceCurrency, TargetCurrency, and ConversionRate objects.

---

SourceCurrency

The currency code based on the location of the hotel and used for all rates in the response.

Properties:

decimalPlace: Number of decimal places for the currency value.

value: Currency code.

---

TargetCurrency

Currency code sent in the request in requestedCurrency.

Properties:

decimalPlace: Number of decimal places

value: Currency code.

---

ConversionRate

Current conversion rate of the user-specified currency (the TargetCurrency value).

Properties:

value: Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response.

Example

{
 "PropertiesResponse": {
  "Properties": {
   "@type": "Properties",
   "Identifier": {
    "value": "e0690cc0-5f97-4e01-a90c-c05f978e01da"
   },
   "totalProperties": 51,
   "propertiesPerPage": 51,
   "numberOfPages": 1,
   "PropertyInfo": [
    {
     "@type": "PropertyInfo",
     "id": "DT-35429",
     "Identifier": {
      "authority": "TVPT"
     },
     "availability": "Open",
     "Distance": {
      "value": 0.23,
      "unitOfDistance": "Miles"
     },
     "Property": {
      "@type": "PropertyDetail",
      "id": "DT-35429",
      "PropertyKey": {
       "@type": "PropertyKey",
       "chainCode": "DT",
       "propertyCode": "35429"
      },
      "name": "THE CURTIS DENVER   A DOUBLETREE BY",
      "Rating": [
       {
        "value": 3,
        "provider": "AAA"
       },
       {
        "value": 3,
        "provider": "NTM"
       },
       {
        "value": 4,
        "provider": "GIATA"
       }
      ],
      "GeoLocation": {
       "latitude": 39.745722,
       "longitude": -104.996919
      },
      "Image": [
       {
        "value": "https://media.iceportal.com/59424/photos/73564156_M.jpg",
        "dimensionCategory": "M",
        "caption": "On-Site,Outdoor/Exterior,Exterior View of Building",
        "pictureCategory": 1
       }
      ],
      "Address": {
       "@type": "Address",
       "AddressLine": [
        "1405 Curtis Street"
       ],
       "City": "DENVER",
       "StateProv": {
        "value": "CO"
       },
       "Country": {
        "value": "US"
       },
       "PostalCode": "80202"
      },
      "Telephone": [
       "1-303-5710300"
      ],
      "PropertyAmenity": [
       {
        "@type": "PropertyAmenity",
        "description": "Complimentary breakfast",
        "code": "227",
        "category": "Breakfast"
       },
       {
        "@type": "PropertyAmenity",
        "description": "Free Parking",
        "code": "42",
        "category": "Free Parking"
       }
      ]
     },
     "LowestAvailableRate": {
      "value": 175.42,
      "code": "USD"
     },
     "MaximumAvailableRate": {
      "value": 430.92,
      "code": "USD"
     }
    }
   ]
  },
  "traceId": "b39344c0-60fa-4bf4-8be8-d4f69fd27e03",
  "Result": {
   "@type": "Result",
   "Warning": [
    {
     "@type": "Warning",
     "StatusCode": 99,
     "Message": "Images unavailable for 1 properties."
    }
   ]
  }
 }
}