# GetHotelSummary

This API retrieves hotel-related content. The response returns a file stream in CSV format, which includes details such as the hotel's name, address, and phone number among others. It is recommended to synchronize this data weekly for the most up-to-date information.
If there is a need to map room types, please reach out to the Dida API team. They will assist in setting this up in advance. Once the setup is complete, you can modify the keywords from "HotelSummary" to "RoomType" to retrieve Dida room type information.
When "IsGetUrlOnly=true", the "FileType" field supports two file formats for selection: Csv and Zip. (Please note capitalization)

POST
https://apiint.didatravel.com/api/staticdata/GetStaticInformation?$format=json
In the following example, the code parameters inside are modifiable.
Use the following method to test API:
{
    "IsGetUrlOnly": true,
    "Header": {
        "LicenseKey": "TestKey",
        "ClientID": "DidaApiTestID"
    },
    "StaticType": "HotelSummary",
    "FileType":"Csv"
}
In the following example, the code parameters inside are modifiable.
Use the following method to test API:
<GetStaticInformationRQ>
  <Header>
    <ClientID>DidaApiTestID</ClientID>
    <LicenseKey>TestKey</LicenseKey>
  </Header>
  <StaticType>HotelSummary</StaticType>
  <IsGetUrlOnly>true</IsGetUrlOnly>
  <FileType>Csv</FileType>
</GetStaticInformationRQ>

CSV file field description:

Field Type Mandatory Remarks
HotelID int true Unique hotel identification
Name string true Name of hotel
Name_CN string false Chinese name of hotel
Address string false Address
CityCode long true City code
CityName string true Name of city
CityName_CN string false Chinese name of city
StateCode string true State code
CountryCode string true Country code
CountryName string true Name of country
CountryName_CN string false Chinese name of country
ZipCode string false Zip code
Longitude string false Longitude
Latitude string false Latitude
StarRating double false Star rating
Telephone string false Tele phone
AirportCode string false Airport code
PropertyCategory int false Property category (Dida does not guarantee accuracy, only for reference)
DestinationID long false Destination unique identification
DestinationName string false Name of destination
DestinationName_CN string false Chinese name of destination
Address_CN string false Detailed Chinese address of the hotel
UpdateDate string true Update date

PropertyCategory field description:

ID Description_EN Description_CN
0 Hotel-unknown 不知名的酒店
1 Hotel 酒店
2 Motel 汽车旅馆
3 Hotel resort 度假酒店
4 Inn 旅馆
5 Bed & breakfast 家庭客栈
6 Guest house 客房旅馆
7 Condo 公寓
8 All-Inclusive 包括所有
9 Cabin 小木屋
10 Chalet 牧人小屋
11 Cottage 小别墅
12 Hostel/Backpacker accommodation 招待所
13 Ranch 场主房屋
14 Villa 别墅
15 Lodge 山间小屋
16 Apartment 公寓
17 Private vacation home 私人度假住宅
18 House boat 船屋
20 Ryokan 日式旅店
21 Tree house 树屋
22 Apart-hotel 公寓酒店
23 Condominium resort 度假村
24 Campsite 房车露营地
25 Riad 摩洛哥特色旅馆
26 Hostal (Budget Hotel) Hostal (廉价旅馆)
29 Country House 乡间别墅
30 Pension 民宿
31 Pousada (Portugal) Pousada (葡萄牙)
32 Pousada (Brazil) Pousada (巴西)
33 Residence 公寓式住宅
34 TownHouse 排屋
36 Castle 城堡
37 Safari / Tentalow Safari / 帐篷屋
39 Palace 宫殿
40 Agritourism 观光农业旅游
41 Cruise 游轮
42 Holiday Park
   [
    {
        "name": "Header",
        "description": "Client authentication info",
        "children": [
            {
                "name": "ClientID",
                "description": "Client ID"
            },
            {
                "name": "LicenseKey",
                "description": "Client password"
            }
        ]
    },
    {
        "name": "StaticType",
        "description": "Static information type. For instance: HotelSummary."
    },
    {
        "name": "IsGetUrlOnly",
        "description": "Return download url if true. Need extra code to handle HTTP 302 if it is false."
    },
    {
        "name": "FileType",
        "description": "Optional fields, currently supports two file types: Csv and Zip. (Please note capitalization)"
    }
]
Request Parameters
Header HeaderType
Client authentication infoHeaderType
StaticType GetStaticInformationRQStaticType Static information type. For instance: HotelSummary.GetStaticInformationRQStaticType
IsGetUrlOnly Boolean Required Return download url if true. Need extra code to handle HTTP 302 if it is false.BooleanRequired
FileType String Optional fields, currently supports two file types: Csv and Zip. (Please note capitalization)String
Request Sample
{
    "Header": {
        "LicenseKey": "TestKey",
        "ClientID": "DidaApiTestID"
    },
    "IsGetUrlOnly": true,
    "StaticType": "HotelSummary"
}
Request Sample
<GetStaticInformationRQ>
  <Header>
    <ClientID>DidaApiTestID</ClientID>
    <LicenseKey>TestKey</LicenseKey>
  </Header>
  <StaticType>HotelSummary</StaticType>
  <IsGetUrlOnly>true</IsGetUrlOnly>
</GetStaticInformationRQ>
Response Parameters
Url String Static resource URL. If IsGetUrlOnly = false, response will redirect to the resource URL. Redirection needs to be supported by client.String
Response Sample
{
    "Url": "http://static.didatravel.com/Static/2/HotelSummary.csv?Expires=1502938618&OSSAccessKeyId=jr9mtwydMaatBmPp&Signature=FPPlGzq6qMik%2BRW8%2FFjVXlEHHB4%3D"
}
Response Sample
<?xml version="1.0"?>
<GetStaticInformationRS>
  <Url>http://static.didatravel.com/Static/2/HotelSummary.csv?Expires=1502938618&OSSAccessKeyId=jr9mtwydMaatBmPp&Signature=FPPlGzq6qMik%2BRW8%2FFjVXlEHHB4%3D</Url>
</GetStaticInformationRS>