| 楽天トラベル施設検索API(SimpleHotelSearch) SOAP用入力パラメーター version:2007-11-21 |
| 区分 |
ID |
項目名 |
フィールド名 |
型 |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
バージョン |
apiVersion |
String |
○ |
--- |
1.11 |
| 2 |
大区分コード |
largeClassCode |
String |
○ (*1) (*2) |
--- |
国などを示すコード。地区コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。 |
| 3 |
中区分コード |
middleClassCode |
String |
○ (*1) (*2) |
--- |
都道府県などを示すコード。コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。 |
| 4 |
小区分コード |
smallClassCode |
String |
○ (*1) (*2) |
--- |
市など示すコード。コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。 |
| 5 |
細区分コード |
detailClassCode |
String |
○ (*1) (*2) |
--- |
駅や詳細地域などを示すコード。コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。 |
| 6 |
施設番号 |
hotelNo |
String |
○ (*1) |
--- |
楽天トラベルにおける施設を特定するためのNo
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
このフィールドは複数指定することができます。
例)12345,54321 |
| 7 |
緯度 |
latitude |
String |
○ (*1) |
--- |
日本測地系(Tokyo Datum)、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)128216.17
ただし、datumTypeに1を指定した場合は、
世界測地系、単位は度で指定すること。
例)35.6065914
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。 |
| 8 |
経度 |
longitude |
String |
○ (*1) |
--- |
日本測地系(Tokyo Datum)、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)503259.29
ただし、datumTypeに1を指定した場合は、
世界測地系、単位は度で指定すること。
例)139.7513225
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。 |
| 9 |
検索半径 |
searchRadius |
String |
- |
1 |
緯度経度検索時の検索半径(単位km)
0.1以上、3.0以下であり、小数点以下は1桁までであること |
| 10 |
絞込み条件 |
squeezeCondition |
String |
- |
--- |
kinen:禁煙ルーム internet:インターネットが出来る部屋
daiyoku:大浴場あり onsen:温泉
このフィールドは複数指定することができます。
例)禁煙ルームのある温泉宿
&squeezeCondition=kinen,onsen |
| 11 |
キャリア情報 |
carrier |
String |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC:0
mobile:1 |
| 12 |
取得件数 |
hits |
String |
- |
--- |
取得件数を制限するパラメーター。
緯度経度での検索のみに適用し、指定された座標から近い順にソートした結果を返す。 |
| 13 |
緯度経度タイプ |
datumType |
String |
- |
2 |
APIで扱う(入力及び出力)緯度経度のタイプを指定する。
1:世界測地系、単位は度。
2:日本測地系、単位は秒。デフォルト値。 |