Hotel Data
Get details of designated hotel opening
Request Method#
POST
uri: /hotel
Content-Type:application/json
Request parameter description#
RequestHeader#
Common Request Header [reference]
RequestBody#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| hotelId | String | Y | 32 | 12 * * 567 | Hotel ID |
Response parameter description#
Common Response Parameters [reference]
content#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| hotelId | String | Y | 32 | 12 * * 567 | Hotel ID |
| hotelName | String | Y | 500 | Hotel name | |
| hotelNameEn | String | N | 500 | Hotel name (English) | |
| brandCode | Integer | Y | 50 | Hotel Brand Code | |
| brandName | String | Y | 50 | Hotel Brand Name | |
| provinceNo | String | Y | 16 | Province/State Code | |
| provinceName | String | Y | 64 | Province/State Name | |
| cityNo | String | Y | 16 | City Code | |
| cityName | String | Y | 64 | City Name | |
| countyNo | String | Y | 16 | County code | |
| countyName | String | Y | 64 | District name | |
| hotelAddress | String | N | 500 | Address | |
| hotelAddressEn | String | N | 500 | Address | |
| hotelAddressTip | String | N | 500 | Address Hint | |
| telephone | String | N | 200 | Phone | |
| phoneCode | String | N | 16 | Area Code | |
| fax | String | N | 50 | Fax | |
| zipCode | String | N | 50 | Zip code | |
| roomNum | Integer | N | - | Number of rooms | |
| hotelWordIntroduce | String | N | 2000 | Hotel Introduction | |
| longitude | String | N | 50 | Longitude (eg:"57.038973") | |
| latitude | String | N | 50 | Latitude (eg:"9.937596") | |
| openingDate | Date | N | - | Official business date, format: yyyy-MM-dd | |
| firstOpeningDate | Date | N | - | First opening date, format: yyyy-MM-dd | |
| overhaulTime | Date | N | - | Last decoration time, format: yyyy-MM-dd | |
| trialOpeningDate | Date | N | - | Hotel trial opening date, format: yyyy-MM-dd | |
| operateScopeId | Integer | N | - | Operate scopeid, Enumeration reference Business Scope | |
| contactPosition | String | - | - | Title (Deprecated) | |
| contactName | String | - | - | Name (Deprecated) | |
| String | N | 100 | Email, contact hotel email | ||
| international | Boolean | Y | - | Whether it is an international hotel, Enumeration reference whether it is international | |
| tradeCurrency | String | N | 20 | Currency, international standard: ISO-4217 | |
| invoiceType | Integer | N | - | Invoice Type, Enumeration reference Invoice Type | |
| scaleOfTaxpayer | Integer | N | - | Taxpayer Size, Enumeration reference Invoice Type | |
| cleanLevel | Integer | N | - | clean level, Enumeration reference clean level | |
| hotelRoomTypeList | List<HotelRoomType> | N | - | Hotel Room Type Information | |
| hotelServiceList | List<HotelService> | N | - | Hotel Services | |
| hotelPhotoList | List<HotelPhoto> | N | - | Hotel Image Information | |
| hotelTrafficList | List<HotelTraffic> | N | - | Hotel Traffic Information |
HotelRoomType#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| roomTypeCode | String | Y | 64 | Room Code | |
| roomTypeName | String | Y | 200 | Room name | |
| roomNum | Integer | N | - | Number of rooms | |
| summary | String | N | 500 | Introduction to Room Type | |
| hotelArea | Integer | N | - | Area in Square Meters | |
| floorPlace | String | N | 200 | Floor, e.g. 1: for 1st floor | |
| bedWidth | String | N | 200 | Bed width in meters | |
| isADSL | String | N | 50 | Whether broadband Internet access is available, and the Enumeration reference width Internet access | |
| isADSLWifi | String | N | 50 | Whether guest room wifi coverage, Enumeration reference guest room wifi coverage | |
| isHasWindow | String | N | 50 | Whether there is a window, Enumeration reference whether there is a window | |
| isCanAddBed | String | N | 50 | Enumeration reference extra bed | |
| hasSmokeFree | String | N | 50 | Smoke-free, Enumeration reference whether there is a smoke room | |
| maxOccupancy | Integer | N | - | Maximum occupancy | |
| maxAdult | Integer | N | - | Maximum Number of People | |
| maxChild | Integer | N | - | Maximum number of children | |
| status | Integer | N | - | Status, Status of Room 1-Enabled 0-Disabled | |
| bedTypeList | List<BedType> | Y | - | Bed Type |
BedType#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| bedTypeCode | String | Y | 20 | Bed type code | |
| bedSpecNo | String | Y | 50 | Bed type specification business number (-1 indicates the group default specification) | |
| bedTypeName | String | N | 100 | Bed type name | |
| bedSpec | String | N | 50 | Bed type specification name |
HotelService#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| childClassName | String | N | 50 | Facility Name | |
| childClassCode | Integer | N | 50 | Facility Code, Enumeration reference typeMappingCode | |
| childClassNameDesc | String | N | 200 | Facility description |
HotelPhoto#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| fileName | String | N | 200 | Filename | |
| fileTitle | String | N | 100 | Picture Title | |
| fileFormat | String | N | 20 | File format | |
| fileSize | Double | N | 1510 | File Size | |
| typeCode | String | N | 20 | File type, Enumeration reference typeCode | |
| typeMappingCode | String | N | 50 | The specific code corresponding to the type, the Enumeration reference typeMappingCode | |
| descript | String | N | 500 | Document description | |
| sortId | Integer | N | - | sort value, the smaller the number, the image presentation has a higher priority | |
| fileUrl | String | N | 200 | Image URL | |
| status | Integer | N | - | Status 1-Enabled 0-Disabled |
HotelTraffic#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| destinationType | String | N | 10 | Destination type, Enumeration reference destination type | |
| destinationTypeName | String | N | 256 | Destination Type Name | |
| destinationName | String | N | 256 | Destination name | |
| destinationDistance | String | N | 50 | Destination distance | |
| trafficTips | String | N | 512 | Traffic Alert |
ResponseCode#
| Exception Code | Exception Type | Description |
|---|---|---|
| 1000 | Success | |
| 3201 | Invalid hotel Id | Hotel Id does not exist |
| 3202 | Hotel is closed | Hotel is closed |
| 3203 | No hotel detail can be found | no hotel details found |
| 3204 | The number of requests exceeded the daily limit | |
| Others | Global Exception Code | Global Exception [Reference] |