Hotel Descriptive Info
POST/v1/api/Pull/GetHotelDescriptiveInfo
Provides information about hotel, rooms, multimedia, policies, etc.
Request
- application/json
Body
- Array [
- ]
- Array [
- MOD1
- MOD2
- MOD1
- MOD2
- ]
Possible values: [8
, 4
, 3
, 1
, 2
, 5
, 6
, 7
]
Default value: 8
The primary language code for the request (e.g., 'BR' for Brazilian Portuguese).
LanguageCodeEnum:
8=BR
| 4=PT
| 3=ES
| 1=EN
| 2=FR
| 5=DA
| 6=IT
| 7=DE
An arbitrary string returned in the response for tracking/debugging.
The date and time (ISO format) just before the request is sent.
Possible values: [0
, 1
]
The target environment for this request.
TargetEnum:
0=Test
| 1=Production
Default value: 1
The version number of this request format.
POSType objectnullable
Sources object[]
A list of source information for the point of sale.
Default value: BRA
The pseudo city code (PCC).
The ISO 3166-1 alpha-2 country code.
RequestorID objectnullable
Information about the requestor.
The ID of the requestor.
Possible values: [3
, 4
, 14
, 25
]
A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
UniqueIdTypeEnum:
3=CorporationRepresentative
| 4=Company
| 14=Reservation
| 25=AssociatedReservation
HotelDescriptiveInfosType object
HotelDescriptiveInfos object[]required
A list of hotel descriptive information requests, each for a different hotel.
AffiliationInfo object
Request information about the hotel's affiliations, including awards.
Default value: false
Controls if the Awards data should be present in the response.
AreaInfo object
Request information about the area surrounding the hotel, including attractions and reference points.
Default value: false
Controls if the AreaInfo data should be present in the response.
Default value: false
Controls if the RefPoints data should be present in the response.
ContactInfo object
Request contact information for the hotel.
Default value: false
Controls if the ContactInfo data should be present in the response.
FacilityInfo object
Request information about the hotel's facilities, including guest rooms.
Default value: false
Controls if the GuestRooms data should be present in the response.
HotelInfo object
Request general information about the hotel.
Default value: false
Controls if the HotelInfo data should be present in the response.
MultimediaObjects object
Request multimedia data (e.g., images, videos) for the hotel.
Default value: false
Controls if the MultimediaObjects data should be present in the response.
Policies object
Request information about the hotel's policies.
Default value: false
Controls if the Policies data should be present in the response.
HotelRef objectrequired
Reference information for the hotel, including chain code, chain name, hotel code, and hotel name.
ChainCode object nullable
The code of the hotel chain (if applicable).
integer
string
The name of the hotel chain (if applicable).
The name of the hotel.
HotelCode object required
The unique code of the hotel.
integer
string
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- MOD1
- MOD2
- MOD1
- MOD2
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- Array [
- MOD1
- MOD2
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
Possible values: [8
, 4
, 3
, 1
, 2
, 5
, 6
, 7
]
Default value: 8
LanguageCodeEnum:
8=BR
| 4=PT
| 3=ES
| 1=EN
| 2=FR
| 5=DA
| 6=IT
| 7=DE
The same token received in the request.
The date in ISO format right before the response is sent.
Possible values: [0
, 1
]
The environment target. The same value received in the request.
TargetEnum:
0=Test
| 1=Production
Version of the API being used. The same value received in the request.
Success objectnullable
WarningsType objectnullable
Warnings object[]
Error code associated with the warning.
Possible values: [8
, 4
, 3
, 1
, 2
, 5
, 6
, 7
]
Language of the warning message.
LanguageCodeEnum:
8=BR
| 4=PT
| 3=ES
| 1=EN
| 2=FR
| 5=DA
| 6=IT
| 7=DE
Short description or summary of the warning.
ErrorsType objectnullable
Errors object[]
Error code associated with the warning.
Possible values: [8
, 4
, 3
, 1
, 2
, 5
, 6
, 7
]
Language of the warning message.
LanguageCodeEnum:
8=BR
| 4=PT
| 3=ES
| 1=EN
| 2=FR
| 5=DA
| 6=IT
| 7=DE
Short description or summary of the warning.
HotelDescriptiveContentsType object
HotelDescriptiveContents object[]nullable
A list of hotel descriptive content objects, each containing detailed information about a hotel.
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
, 13
, 14
, 15
, 16
, 17
, 18
, 19
, 20
, 21
, 22
, 23
, 24
, 25
, 26
, 27
, 28
, 29
, 30
, 31
, 32
, 33
, 34
, 43
, 44
, 46
, 47
, 50
, 52
, 56
, 59
, 62
, 64
, 66
, 72
, 76
, 82
, 83
, 85
, 86
, 91
, 94
, 97
, 98
, 102
, 104
, 108
, 109
, 117
, 118
, 119
, 120
, 121
, 122
, 123
, 124
, 125
, 126
, 127
, 128
, 129
, 130
, 131
, 132
, 133
, 134
, 135
, 136
, 137
, 138
, 139
, 140
, 141
, 142
, 143
, 144
, 145
, 146
, 147
, 148
, 149
, 150
, 151
, 152
, 153
, 154
, 155
, 156
, 157
, 158
, 159
, 160
, 161
, 162
, 163
, 164
, 165
, 166
, 167
, 168
, 169
, 170
, 171
, 172
, 173
, 174
, 175
, 176
, 177
, 178
, 179
, 180
, 181
, 182
, 183
, 184
, 185
, 186
, 187
, 188
, 189
, 190
, 191
, 192
, 193
, 194
, 195
, 196
, 197
, 198
, 199
, 200
, 201
, 202
, 203
, 204
, 205
, 206
, 207
, 208
, 209
, 210
, 211
, 212
, 213
, 214
, 215
, 216
, 217
, 218
, 219
, 220
, 221
, 222
, 223
, 224
, 225
, 226
, 227
, 228
, 229
, 230
, 231
, 232
, 233
, 234
, 235
, 236
, 237
, 238
]
The currency code used for prices at the hotel (e.g., 'USD', 'EUR').
CurrencyCodeEnum:
1=ALL
| 2=AFN
| 3=ARS
| 4=AWG
| 5=AUD
| 6=AZN
| 7=BSD
| 8=BBD
| 9=BYR
| 10=BZD
| 11=BMD
| 12=BOB
| 13=BAM
| 14=BWP
| 15=BGN
| 16=BRL
| 17=BND
| 18=KHR
| 19=CAD
| 20=KYD
| 21=CLP
| 22=CNY
| 23=COP
| 24=CRC
| 25=HRK
| 26=CUP
| 27=CZK
| 28=DKK
| 29=DOP
| 30=XCD
| 31=EGP
| 32=SVC
| 33=EEK
| 34=EUR
| 43=HKD
| 44=HUF
| 46=INR
| 47=IDR
| 50=ILS
| 52=JPY
| 56=KRW
| 59=LVL
| 62=LTL
| 64=MYR
| 66=MXN
| 72=NZD
| 76=NOK
| 82=PHP
| 83=PLN
| 85=RON
| 86=RUB
| 91=SGD
| 94=ZAR
| 97=SEK
| 98=CHF
| 102=THB
| 104=TRY
| 108=GBP
| 109=USD
| 117=MAD
| 118=MZN
| 119=VEF
| 120=PEN
| 121=AED
| 122=AMD
| 123=ANG
| 124=AOA
| 125=BDT
| 126=BHD
| 127=BIF
| 128=BOV
| 129=BTN
| 130=CDF
| 131=CHE
| 132=CHW
| 133=CLF
| 134=COU
| 135=CUC
| 136=CVE
| 137=DJF
| 138=DZD
| 139=ERN
| 140=ETB
| 141=FJD
| 142=FKP
| 143=GEL
| 144=GHS
| 145=GIP
| 146=GMD
| 147=GNF
| 148=GTQ
| 149=GYD
| 150=HNL
| 151=HTG
| 152=IQD
| 153=IRR
| 154=ISK
| 155=JMD
| 156=JOD
| 157=KES
| 158=KGS
| 159=KMF
| 160=KPW
| 161=KWD
| 162=KZT
| 163=LAK
| 164=LBP
| 165=LKR
| 166=LRD
| 167=LSL
| 168=LYD
| 169=MDL
| 170=MGA
| 171=MKD
| 172=MMK
| 173=MNT
| 174=MOP
| 175=MRO
| 176=MUR
| 177=MVR
| 178=MWK
| 179=MXV
| 180=NAD
| 181=NGN
| 182=NIO
| 183=NPR
| 184=OMR
| 185=PAB
| 186=PGK
| 187=PKR
| 188=PYG
| 189=QAR
| 190=RSD
| 191=RWF
| 192=SAR
| 193=SBD
| 194=SCR
| 195=SDG
| 196=SHP
| 197=SLL
| 198=SOS
| 199=SRD
| 200=SSP
| 201=STD
| 202=SYP
| 203=SZL
| 204=TJS
| 205=TMT
| 206=TND
| 207=TOP
| 208=TTD
| 209=TWD
| 210=TZS
| 211=UAH
| 212=UGX
| 213=USN
| 214=UYI
| 215=UYU
| 216=UZS
| 217=VND
| 218=VUV
| 219=WST
| 220=XAF
| 221=XAG
| 222=XAU
| 223=XBA
| 224=XBB
| 225=XBC
| 226=XBD
| 227=XDR
| 228=XOF
| 229=XPD
| 230=XPF
| 231=XPT
| 232=XSU
| 233=XTS
| 234=XUA
| 235=XXX
| 236=YER
| 237=ZMW
| 238=ZWL
The hotel's timezone in the format of "(UTC-
HotelRef objectrequired
Reference information for the hotel, including chain code, chain name, hotel code, and hotel name.
ChainCode object nullable
The code of the hotel chain (if applicable).
integer
string
The name of the hotel chain (if applicable).
The name of the hotel.
HotelCode object required
The unique code of the hotel.
integer
string
HotelInfo objectrequired
General information about the hotel, such as name, address, description, etc.
The year the hotel was built.
The number of floors in the hotel.
The number of handicap-accessible rooms in the hotel.
The number of smoking rooms in the hotel.
Default value: false
Indicates whether the hotel is entirely non-smoking (True) or not (False).
CheckInHours objectnullable
The check-in hours for the hotel.
BreakfastHours objectnullable
The breakfast hours for the hotel.
ReceptionHours objectnullable
The reception hours for the hotel.
ClosedSeasonsType objectnullable
Periods during which the hotel is closed.
ClosedSeasons object[]nullable
A list of periods during which the hotel is closed.
The start date (ISO 8601 format) of the closed season.
The duration of the closed season in days.
The end date (ISO 8601 format) of the closed season.
Descriptions objectnullable
Descriptions of the hotel in multiple languages.
Renovations object[]nullable
Information about any renovations that have been done at the hotel.
The date (ISO 8601 format) when the renovation was completed.
A general descriptive text about the hotel.
MultimediaDescriptionsType objectnullable
Multimedia descriptions of the hotel, including images, videos, and text.
MultimediaDescriptions object[]
A list of multimedia descriptions for the hotel, including images, videos, and text.
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
, 13
, 14
, 15
, 16
, 17
, 18
, 19
, 20
, 21
, 22
, 23
, 24
, 25
, 26
]
Used to designate a particular type of description such as marketing. Refer to OpenTravel Code List Information Type (INF).
InformationTypeEnum:
1=Description
| 2=Policy
| 3=Marketing
| 4=SpecialInstructions
| 5=Other
| 6=Amenities
| 7=Attractions
| 8=Awards
| 9=CorporateLocations
| 10=Dining
| 11=DrivingDirections
| 12=Facilities
| 13=Recreation
| 14=Safety
| 15=Services
| 16=Transportation
| 17=ShortDescription
| 18=Advisory
| 19=Geocodes
| 20=Location
| 21=Address
| 22=Contact
| 23=Pictures
| 24=DescriptiveContent
| 25=LongName
| 26=AliasName
Possible values: [2
, 3
, 4
, 14
, 11
, 12
]
Used to designate a particular type of additional information. Refer to OpenTravel Code List Additional Detail Type (ADT).
AdditionalDetailTypeEnum:
2=PropertyDescription
| 3=PropertyLocation
| 4=RoomInformation
| 14=MiscellaneousInformation
| 11=ServiceInformation
| 12=PackageInformation
TextItemsType objectnullable
Textual descriptions associated with the multimedia item.
TextItems object[]nullable
A list of text items associated with the multimedia description.
The name or title of the text item.
The descriptive text content of the item.
ImageItemsType objectnullable
Image items associated with the multimedia item.
ImageItems object[]nullable
A list of image items associated with the multimedia description.
URL objectrequired
The URL details of the image, including address and type.
The URL address (if applicable).
An integer code representing the type of URL (e.g., website, image URL, etc.).
Position object
The geographical coordinates (latitude and longitude) of the image (if applicable).
The latitude coordinate of the location.
The longitude coordinate of the location.
The name or title of the image.
A description of the image.
ImageFormat object[]nullable
A list of information about the format of the image.
The sort order of the image within a list of images.
Default value: false
Indicates if the image is the primary image for the item (True) or not (False).
VideoItemsType objectnullable
Video items associated with the multimedia item.
VideoItems object[]nullable
A list of video items associated with the multimedia description.
Position object
The geographical coordinates (latitude and longitude) associated with the video (if applicable).
The latitude coordinate of the location.
The longitude coordinate of the location.
URL objectnullable
The URL details of the video, including address and type.
The URL address (if applicable).
An integer code representing the type of URL (e.g., website, image URL, etc.).
The name or title of the video.
Possible values: [8
, 4
, 3
, 1
, 2
, 5
, 6
, 7
]
The language of the video's audio (if applicable).
LanguageCodeEnum:
8=BR
| 4=PT
| 3=ES
| 1=EN
| 2=FR
| 5=DA
| 6=IT
| 7=DE
A description of the video.
CategoryCodes objectrequired
Category codes for the hotel.
HotelCategory objectrequired
The category of the hotel.
Possible values: [2
, 3
, 4
, 16
, 19
, 20
, 21
, 22
, 30
, 42
, 48
, 57
, 62
]
The classification of the hotel property (e.g., luxury, budget).
PropertyClassTypeEnum:
2=AllInclusive
| 3=Apartment
| 4=BedAndBreakfast
| 16=GuestHouse
| 19=Hostel
| 20=Hotel
| 21=Inn
| 22=Lodge
| 30=Resort
| 42=Spa
| 48=Historical
| 57=Luxury
| 62=Other
Position objectrequired
The geographic coordinates (latitude and longitude) of the hotel.
The latitude coordinate of the location.
The longitude coordinate of the location.
HotelAmenities object[]
A list of amenities offered by the hotel.
A code identifying the hotel amenity (e.g., 'POOL' for swimming pool).
A description of the hotel amenity.
OwnershipManagementInfosType objectnullable
Information about the ownership and management of the hotel.
OwnershipManagmentInfo object[]required
A list of ownership and management information for the hotel.
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
, 13
, 14
, 15
]
The location type of the ownership or management entity (e.g., 'Hotel', 'Corporate').
ContactLocationEnum:
1=CentralReservationOffice
| 2=CorporateHeadquarters
| 3=CorporateOffice
| 4=DivisionalOffice
| 5=GlobalSalesOffice
| 6=HotelDirect
| 7=LocalReservationOffice
| 8=SalesOffice
| 9=FranchiseCompany
| 10=ManagementCompany
| 11=OwnershipCompany
| 12=CustomerServiceOffice
| 13=HomeResidence
| 14=RegionalSalesOffice
| 15=TechnicalSupportOffice
A numerical code representing the relationship type (e.g., 'Owner', 'Manager').
Names objectnullable
The names of the individuals or entities involved in ownership or management.
Names object[]nullable
A list of names (e.g., for contacts).
A numerical code representing the person's name prefix (e.g., Mr., Ms., Dr.).
The person's given name (first name).
Phones objectnullable
Phone numbers associated with the ownership or management entity.
ContactNumbers object[]nullable
A list of contact phone numbers.
An indicator for sharing or synchronization of the phone number.
An indicator for sharing the phone number within a market.
The phone number.
Possible values: [0
, 1
, 3
, 5
]
Default value: 1
The technology type of the phone (e.g., Voice, Fax).
PhoneTechTypeEnum:
0=None
| 1=Voice
| 3=Fax
| 5=Mobile
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
]
Default value: 7
The location type of the phone (e.g., Office, Home).
PhoneLocationTypeEnum:
1=BrandReservationsOffice
| 2=CentralReservationsOffice
| 3=PropertyReservationOffice
| 4=PropertyDirect
| 5=SalesOffice
| 6=Home
| 7=Office
| 8=Other
| 9=ManagingCompany
Email addresses associated with the ownership or management entity.
The total number of rooms in the hotel.
Marked code.
SurroundingRegions object[]
A list of regions, according to Niara's content, whose geographical boundaries contain or intersect with the property's location.
Unique identifier or code for the region.
Possible values: [city
, country
, neighborhood
, state
, multi_city_vicinity
, point_of_interest
, airport
, high_level_region
, province_state
, continent
, train_station
, metro_station
]
The type or category of the surrounding region (e.g., city, state, country).
FacilityInfo objectrequired
Information about the hotel's facilities, such as rooms, amenities, restaurants, etc.
GuestRoomsType objectnullable
Information about the types of guest rooms available at the hotel.
GuestRooms object[]
A list of guest room types available at the hotel.
The number of rooms of this type available.
The maximum number of guests allowed in this room type.
The maximum number of adult guests allowed in this room type.
Default value: 1
The minimum number of adult guests required in this room type.
The unique identifier for this guest room.
The maximum number of children allowed in this room type.
The maximum number of children allowed in this room type without additional charge.
AmenitiesType objectnullable
Information about the amenities provided in this room type.
RoomAmenities object[]
A list of amenities available in the room.
The code of the room amenity.
A description of the room amenity.
MultimediaDescriptionsType objectnullable
Multimedia descriptions (e.g., images, videos) for this room type.
MultimediaDescriptions object[]
A list of multimedia descriptions for the hotel, including images, videos, and text.
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
, 13
, 14
, 15
, 16
, 17
, 18
, 19
, 20
, 21
, 22
, 23
, 24
, 25
, 26
]
Used to designate a particular type of description such as marketing. Refer to OpenTravel Code List Information Type (INF).
InformationTypeEnum:
1=Description
| 2=Policy
| 3=Marketing
| 4=SpecialInstructions
| 5=Other
| 6=Amenities
| 7=Attractions
| 8=Awards
| 9=CorporateLocations
| 10=Dining
| 11=DrivingDirections
| 12=Facilities
| 13=Recreation
| 14=Safety
| 15=Services
| 16=Transportation
| 17=ShortDescription
| 18=Advisory
| 19=Geocodes
| 20=Location
| 21=Address
| 22=Contact
| 23=Pictures
| 24=DescriptiveContent
| 25=LongName
| 26=AliasName
Possible values: [2
, 3
, 4
, 14
, 11
, 12
]
Used to designate a particular type of additional information. Refer to OpenTravel Code List Additional Detail Type (ADT).
AdditionalDetailTypeEnum:
2=PropertyDescription
| 3=PropertyLocation
| 4=RoomInformation
| 14=MiscellaneousInformation
| 11=ServiceInformation
| 12=PackageInformation
TextItemsType objectnullable
Textual descriptions associated with the multimedia item.
TextItems object[]nullable
A list of text items associated with the multimedia description.
The name or title of the text item.
The descriptive text content of the item.
ImageItemsType objectnullable
Image items associated with the multimedia item.
ImageItems object[]nullable
A list of image items associated with the multimedia description.
URL objectrequired
The URL details of the image, including address and type.
The URL address (if applicable).
An integer code representing the type of URL (e.g., website, image URL, etc.).
Position object
The geographical coordinates (latitude and longitude) of the image (if applicable).
The latitude coordinate of the location.
The longitude coordinate of the location.
The name or title of the image.
A description of the image.
ImageFormat object[]nullable
A list of information about the format of the image.
The sort order of the image within a list of images.
Default value: false
Indicates if the image is the primary image for the item (True) or not (False).
VideoItemsType objectnullable
Video items associated with the multimedia item.
VideoItems object[]nullable
A list of video items associated with the multimedia description.
Position object
The geographical coordinates (latitude and longitude) associated with the video (if applicable).
The latitude coordinate of the location.
The longitude coordinate of the location.
URL objectnullable
The URL details of the video, including address and type.
The URL address (if applicable).
An integer code representing the type of URL (e.g., website, image URL, etc.).
The name or title of the video.
Possible values: [8
, 4
, 3
, 1
, 2
, 5
, 6
, 7
]
The language of the video's audio (if applicable).
LanguageCodeEnum:
8=BR
| 4=PT
| 3=ES
| 1=EN
| 2=FR
| 5=DA
| 6=IT
| 7=DE
A description of the video.
A text description of the room type.
TypeRoom objectrequired
Information about the type of room, including size, bed types, and classification.
The size of the room in square meters.
The unit of measurement for the room size (e.g., 'sqft', 'sqm').
BedTypeCodes object[]
A list of codes representing the types of beds in the room.
A numerical code from the OpenTravel Alliance (OTA) specifying the bed type.
The name corresponding to the OTA code for the bed type.
RoomClassificationCodes object[]
A list of codes classifying the room type (e.g., standard, deluxe, suite).
A numerical code from the OpenTravel Alliance (OTA) specifying the room classification.
The name corresponding to the OTA code for the room classification.
RoomViewCodes object[]
A list of codes representing the view from the room (e.g., ocean view, city view).
A numerical code from the OpenTravel Alliance (OTA) specifying the room view.
The name corresponding to the OTA code for the room view.
Market code.
ContactInfosType objectnullable
Contact information for the hotel, including phone numbers, email addresses, and websites.
ContactInfos object[]nullable
A list of contact information for the hotel, including different types of contacts (e.g., reservations, general inquiries).
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
, 13
, 14
, 15
]
The location of the contact (e.g., hotel, corporate office).
ContactLocationEnum:
1=CentralReservationOffice
| 2=CorporateHeadquarters
| 3=CorporateOffice
| 4=DivisionalOffice
| 5=GlobalSalesOffice
| 6=HotelDirect
| 7=LocalReservationOffice
| 8=SalesOffice
| 9=FranchiseCompany
| 10=ManagementCompany
| 11=OwnershipCompany
| 12=CustomerServiceOffice
| 13=HomeResidence
| 14=RegionalSalesOffice
| 15=TechnicalSupportOffice
AddressesType objectnullable
Address information for the contact.
Addresses object[]required
A list of addresses associated with the contact.
The street address or line 1 of the address.
CityCode object nullable
A numerical code for the city.
integer
string
The name of the city.
Possible values: [161
, 177
, 209
, 95
, 168
, 94
, 60
, 189
, 186
, 24
, 104
, 56
, 63
, 198
, 49
, 171
, 102
, 113
, 109
, 148
, 158
, 29
, 200
, 97
, 195
, 73
, 71
, 68
, 181
, 82
, 44
, 72
, 112
, 27
, 118
, 79
, 132
, 32
, 75
, 199
, 120
, 90
, 42
, 18
, 156
, 159
, 108
, 211
, 210
, 54
, 122
, 114
, 39
, 129
, 183
, 178
, 137
, 121
, 17
, 149
, 30
, 196
, 188
, 180
, 36
, 92
, 124
, 141
, 138
, 204
, 103
, 110
, 150
, 208
, 190
, 93
, 111
, 187
, 155
, 123
, 52
, 41
, 45
, 106
, 101
, 107
, 173
, 66
, 160
, 134
, 25
, 127
, 131
, 152
, 176
, 197
, 140
, 205
, 143
, 74
, 116
, 46
, 169
, 55
, 157
, 115
, 99
, 81
, 70
, 146
, 43
, 191
, 86
, 128
, 35
, 77
, 172
, 167
, 78
, 85
, 50
, 145
, 125
, 194
, 179
, 136
, 126
, 19
, 62
, 91
, 201
, 185
, 184
, 142
, 26
, 33
, 80
, 119
, 96
, 133
, 76
, 20
, 117
, 174
, 61
, 147
, 206
, 166
, 98
, 175
, 135
, 58
, 38
, 21
, 139
, 31
, 48
, 87
, 219
, 182
, 153
, 203
, 40
, 100
, 65
, 59
, 28
, 193
, 162
, 64
, 22
, 163
, 214
, 218
, 164
, 216
, 83
, 34
, 69
, 84
, 89
, 144
, 57
, 207
, 67
, 53
, 151
, 88
, 23
, 51
, 37
, 154
, 130
, 105
, 192
, 165
, 217
, 47
, 202
, 170
, 213
, 215
, 212
]
The three-letter country code (ISO 3166-1 alpha-3).
CountryCodeEnum:
161=RW
| 177=SO
| 209=YE
| 95=IQ
| 168=SA
| 94=IR
| 60=CY
| 189=TZ
| 186=SY
| 24=AM
| 104=KE
| 56=CD
| 63=DJ
| 198=UG
| 49=CF
| 171=SC
| 102=JO
| 113=LB
| 109=KW
| 148=OM
| 158=QA
| 29=BH
| 200=AE
| 97=IL
| 195=TR
| 73=ET
| 71=ER
| 68=EG
| 181=SD
| 82=GR
| 44=BI
| 72=EE
| 112=LV
| 27=AZ
| 118=LT
| 79=GE
| 132=MD
| 32=BY
| 75=FI
| 199=UA
| 120=MK
| 90=HU
| 42=BG
| 18=AL
| 156=PL
| 159=RO
| 108=XK
| 211=ZW
| 210=ZM
| 54=KM
| 122=MW
| 114=LS
| 39=BW
| 129=MU
| 183=SZ
| 178=ZA
| 137=MZ
| 121=MG
| 17=AF
| 149=PK
| 30=BD
| 196=TM
| 188=TJ
| 180=LK
| 36=BT
| 92=IN
| 124=MV
| 141=NP
| 138=MM
| 204=UZ
| 103=KZ
| 110=KG
| 150=PW
| 208=VD
| 190=TH
| 93=ID
| 111=LA
| 187=TW
| 155=PH
| 123=MY
| 52=CN
| 41=BN
| 45=KH
| 106=KP
| 101=JP
| 107=KR
| 173=SG
| 66=TP
| 160=RU
| 134=MN
| 25=AU
| 127=MH
| 131=FM
| 152=PG
| 176=SB
| 197=TV
| 140=NR
| 205=VU
| 143=NZ
| 74=FJ
| 116=LY
| 46=CM
| 169=SN
| 55=CG
| 157=PT
| 115=LR
| 99=CI
| 81=GH
| 70=GQ
| 146=NG
| 43=BF
| 191=TG
| 86=GW
| 128=MR
| 35=BJ
| 77=GA
| 172=SL
| 167=ST
| 78=GM
| 85=GN
| 50=TD
| 145=NE
| 125=ML
| 194=TN
| 179=ES
| 136=MA
| 126=MT
| 19=DZ
| 62=DK
| 91=IS
| 201=GB
| 185=CH
| 184=SE
| 142=NL
| 26=AT
| 33=BE
| 80=DE
| 119=LU
| 96=IE
| 133=MC
| 76=FR
| 20=AD
| 117=LI
| 174=SK
| 61=CZ
| 147=NO
| 206=VA
| 166=SM
| 98=IT
| 175=SI
| 135=ME
| 58=HR
| 38=BA
| 21=AO
| 139=NA
| 31=BB
| 48=CV
| 87=GY
| 219=GF
| 182=SR
| 153=PY
| 203=UY
| 40=BR
| 100=JM
| 65=DO
| 59=CU
| 28=BS
| 193=TT
| 162=KN
| 64=DM
| 22=AG
| 163=LC
| 214=AW
| 218=VG
| 164=VC
| 216=MF
| 83=GD
| 34=BZ
| 69=SV
| 84=GT
| 89=HN
| 144=NI
| 57=CR
| 207=VE
| 67=EC
| 53=CO
| 151=PA
| 88=HT
| 23=AR
| 51=CL
| 37=BO
| 154=PE
| 130=MX
| 105=KI
| 192=TO
| 165=WS
| 217=PR
| 47=CA
| 202=US
| 170=RS
| 213=CW
| 215=BQ
| 212=HK
The full name of the country.
The postal or zip code.
A numerical code for the state or province.
Name of the state or province.
A numerical code for the zone or area within the city.
Phones objectnullable
Phone numbers for the contact.
ContactNumbers object[]nullable
A list of contact phone numbers.
An indicator for sharing or synchronization of the phone number.
An indicator for sharing the phone number within a market.
The phone number.
Possible values: [0
, 1
, 3
, 5
]
Default value: 1
The technology type of the phone (e.g., Voice, Fax).
PhoneTechTypeEnum:
0=None
| 1=Voice
| 3=Fax
| 5=Mobile
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
]
Default value: 7
The location type of the phone (e.g., Office, Home).
PhoneLocationTypeEnum:
1=BrandReservationsOffice
| 2=CentralReservationsOffice
| 3=PropertyReservationOffice
| 4=PropertyDirect
| 5=SalesOffice
| 6=Home
| 7=Office
| 8=Other
| 9=ManagingCompany
Email addresses for the contact.
URLsType objectnullable
URLs associated with the contact.
URLs object[]
A list of URLs associated with the contact.
The URL address (if applicable).
An integer code representing the type of URL (e.g., website, image URL, etc.).
AffiliationInfo objectnullable
Information about the hotel's affiliations, such as brand or association memberships.
AwardsType objectnullable
Information about awards and recognitions associated with the hotel.
Awards object[]required
A list of awards received by the hotel, including the rating and name of each award.
The numerical rating of the award.
The name or title of the award.
AwardsType objectnullable
A list of awards or recognitions received by the hotel.
Awards object[]required
A list of awards received by the hotel, including the rating and name of each award.
The numerical rating of the award.
The name or title of the award.
AreaInfo objectnullable
Information about the area surrounding the hotel, including attractions and points of interest.
RefPointsType objectnullable
Information about reference points (e.g., airports, train stations) near the hotel.
RefPoints object[]
A list of reference points near the hotel, such as airports, train stations, or other landmarks.
A numerical code representing the category of the reference point (e.g., airport, train station).
A code identifying the reference point (e.g., airport code, station code).
The context or system used for the location code (e.g., IATA for airports).
AttractionsType objectnullable
Information about attractions near the hotel.
Attractions object[]nullable
A list of attractions near the hotel.
A numerical code representing the category of the attraction (e.g., museum, park).
The name of the attraction category if it's not in the standard list.
The name of the attraction.
URL objectnullable
A URL with more information about the attraction.
The URL address (if applicable).
An integer code representing the type of URL (e.g., website, image URL, etc.).
The unique identifier for the attraction.
Policies objectnullable
The hotel's policies regarding check-in, check-out, cancellation, and other aspects of the stay.
The latitude coordinate of the location.
The longitude coordinate of the location.
Possible values: [8
, 4
, 3
, 1
, 2
, 5
, 6
, 7
]
The primary language code (e.g., 'EN', 'ES') for the hotel's information.
LanguageCodeEnum:
8=BR
| 4=PT
| 3=ES
| 1=EN
| 2=FR
| 5=DA
| 6=IT
| 7=DE
TPA_Extensions objectrequired
Additional information or extensions specific to the Travel Partner Agreement (TPA).
The code of the supplier providing the hotel descriptive information.
{
"PrimaryLangID": 8,
"EchoToken": "string",
"TimeStamp": "string",
"Target": 0,
"Version": 0,
"Success": {},
"WarningsType": {
"Warnings": [
{
"Code": 0,
"Language": 8,
"ShortText": "string"
}
]
},
"ErrorsType": {
"Errors": [
{
"Code": 0,
"Language": 8,
"ShortText": "string"
}
]
},
"HotelDescriptiveContentsType": {
"HotelDescriptiveContents": [
{
"CurrencyCode": 1,
"TimeZone": "string",
"HotelRef": {
"ChainCode": 0,
"ChainName": "string",
"HotelName": "string",
"HotelCode": 0
},
"HotelInfo": {
"WhenBuilt": "string",
"NFloors": 0,
"HandicapRooms": 0,
"SmokingRooms": 0,
"NonSmokingHotel": false,
"CheckInHours": {
"Start": "string",
"End": "string"
},
"BreakfastHours": {
"Start": "string",
"End": "string"
},
"ReceptionHours": {
"Start": "string",
"End": "string"
},
"ClosedSeasonsType": {
"ClosedSeasons": [
{
"Start": "string",
"Duration": 0,
"End": "string"
}
]
},
"Descriptions": {
"Renovations": [
{
"RenovationCompletionDate": "string"
}
],
"DescriptiveText": "string",
"MultimediaDescriptionsType": {
"MultimediaDescriptions": [
{
"InfoCode": 1,
"AdditionalDetailCode": 2,
"TextItemsType": {
"TextItems": [
{
"Name": "string",
"Description": "string"
}
]
},
"ImageItemsType": {
"ImageItems": [
{
"URL": {
"Address": "string",
"URLType": 0
},
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"Name": "string",
"Description": "string",
"ImageFormat": [
{
"Sort": 0,
"IsPrimary": false
}
]
}
]
},
"VideoItemsType": {
"VideoItems": [
{
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"URL": {
"Address": "string",
"URLType": 0
},
"Name": "string",
"Language": 8,
"Description": "string"
}
]
}
}
]
}
},
"CategoryCodes": {
"HotelCategory": {
"PropertyClassType": 2
}
},
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"HotelAmenities": [
{
"Code": "string",
"HotelAmenity": "string"
}
],
"OwnershipManagementInfosType": {
"OwnershipManagmentInfo": [
{
"Location": 1,
"RelationshipTypeCode": 0,
"Names": {
"Names": [
{
"NamePrefix": 0,
"GivenName": "string"
}
]
},
"Phones": {
"ContactNumbers": [
{
"ShareSyncInd": 0,
"ShareMarketInd": 0,
"PhoneNumber": "string",
"PhoneTechType": 1,
"PhoneLocationType": 7
}
]
},
"Emails": [
"string"
]
}
]
},
"TotalRooms": 0,
"WLCode": 0,
"SurroundingRegions": [
{
"Code": "string"
}
]
},
"FacilityInfo": {
"GuestRoomsType": {
"GuestRooms": [
{
"Quantity": 0,
"MaxOccupancy": 0,
"MaxAdultOccupancy": 0,
"MinAdultOccupancy": 1,
"ID": 0,
"MaxChildOccupancy": 0,
"MaxFreeChildOccupancy": 0,
"AmenitiesType": {
"RoomAmenities": [
{
"Code": "string",
"RoomAmenity": "string"
}
]
},
"MultimediaDescriptionsType": {
"MultimediaDescriptions": [
{
"InfoCode": 1,
"AdditionalDetailCode": 2,
"TextItemsType": {
"TextItems": [
{
"Name": "string",
"Description": "string"
}
]
},
"ImageItemsType": {
"ImageItems": [
{
"URL": {
"Address": "string",
"URLType": 0
},
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"Name": "string",
"Description": "string",
"ImageFormat": [
{
"Sort": 0,
"IsPrimary": false
}
]
}
]
},
"VideoItemsType": {
"VideoItems": [
{
"Position": {
"Latitude": "string",
"Longitude": "string"
},
"URL": {
"Address": "string",
"URLType": 0
},
"Name": "string",
"Language": 8,
"Description": "string"
}
]
}
}
]
},
"DescriptiveText": "string",
"TypeRoom": {
"Size": 0,
"SizeMeasurement": "string",
"BedTypeCodes": [
{
"OTA_CodeType": 0,
"OTA_CodeName": "string"
}
],
"RoomClassificationCodes": [
{
"OTA_CodeType": 0,
"OTA_CodeName": "string"
}
],
"RoomViewCodes": [
{
"OTA_CodeType": 0,
"OTA_CodeName": "string"
}
]
},
"WLCode": 0
}
]
}
},
"ContactInfosType": {
"ContactInfos": [
{
"Location": 1,
"AddressesType": {
"Addresses": [
{
"AddressLine": "string",
"CityCode": 0,
"CityName": "string",
"CountryCode": 161,
"CountryName": "string",
"PostalCode": "string",
"StateProvCode": 0,
"StateProv": "string",
"ZoneCode": 0
}
]
},
"Phones": {
"ContactNumbers": [
{
"ShareSyncInd": 0,
"ShareMarketInd": 0,
"PhoneNumber": "string",
"PhoneTechType": 1,
"PhoneLocationType": 7
}
]
},
"Emails": [
"string"
],
"URLsType": {
"URLs": [
{
"Address": "string",
"URLType": 0
}
]
}
}
]
},
"AffiliationInfo": {
"AwardsType": {
"Awards": [
{
"Rating": 0,
"Name": "string"
}
]
}
},
"AwardsType": {
"Awards": [
{
"Rating": 0,
"Name": "string"
}
]
},
"AreaInfo": {
"RefPointsType": {
"RefPoints": [
{
"AttractionCategoryType": 0,
"LocationCode": "string",
"CodeContext": 0
}
]
},
"AttractionsType": {
"Attractions": [
{
"AttractionCategoryType": 0,
"OtherCategoryName": "string",
"AttractionName": "string",
"URL": {
"Address": "string",
"URLType": 0
},
"ID": 0
}
]
}
},
"Policies": {
"Latitude": "string",
"Longitude": "string"
},
"PrimaryLangID": 8,
"TPA_Extensions": {
"SupplierCode": "string"
}
}
]
}
}