| 楽天トラベル施設検索API(SimpleHotelSearch) 入力パラメーター version:2009-10-20 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数) |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名:SimpleHotelSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
バージョン |
version |
String |
○ |
--- |
2009-10-20 |
| 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 |
int(10) |
○ (*1) |
--- |
楽天トラベルにおける施設を特定するためのNo
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
このフィールドは15個まで指定することができます。
例)&hotelNo=12345,54321 |
| 7 |
緯度 |
latitude |
decimal |
○ (*1) |
--- |
日本測地系(Tokyo Datum)、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)128216.17
ただし、datumTypeに1を指定した場合は、
世界測地系、単位は度で指定すること。
例)35.6065914
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。 |
| 8 |
経度 |
longitude |
decimal |
○ (*1) |
--- |
日本測地系(Tokyo Datum)、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)503259.29
ただし、datumTypeに1を指定した場合は、
世界測地系、単位は度で指定すること。
例)139.7513225
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。 |
| 9 |
検索半径 |
searchRadius |
int |
- |
1 |
緯度経度検索時の検索半径(単位km)
0.1以上、3.0以下であり、小数点以下は1桁までであること |
| 10 |
絞込み条件 |
squeezeCondition |
String |
- |
--- |
kinen:禁煙ルーム internet:インターネットが出来る部屋
daiyoku:大浴場あり onsen:温泉
このフィールドは複数指定することができます。
例)禁煙ルームのある温泉宿
&squeezeCondition=kinen,onsen |
| 11 |
キャリア情報 |
carrier |
int(1) |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
0:PC
1:mobile |
| 12 |
緯度経度タイプ |
datumType |
int(1) |
- |
2 |
入力及び出力パラメータの緯度経度タイプを指定する。
1:世界測地系、単位は度。
2:日本測地系、単位は秒。 |
| 13 |
取得ページ |
page |
int |
- |
1 |
取得対象のページ数。
1以上、100以下の整数であること。(*1)
(*1)緯度経度検索でallReturnFlagが指定されていた場合、
pageとhitsは無効になります。 |
| 14 |
1ページあたりの取得件数 |
hits |
int |
- |
30 |
1ページ毎の取得件数を制限するパラメータ。
1以上、30以下の整数であること。(*1)
(*1)緯度経度検索でallReturnFlagが指定されていた場合、
pageとhitsは無効になります。 |
| 15 |
施設画像サイズ |
hotelThumbnailSize |
int(1) |
- |
2 |
出力パラメータの施設画像サムネイルURLの画像サイズを指定する。
1:小
2:中
3:大 |
| 16 |
返却情報タイプ |
responseType |
int(1) |
- |
middle |
出力パラメータの返却情報タイプを指定する。 small:最低限の情報のみ
middle:中くらい
large:すべての情報 |
| 17 |
ソート |
sort |
String |
- |
standard |
standard:おすすめ順(*1)
+roomCharge:最安値料金(安い順)
-roomCharge:最安値料金(高い順)
(*1)おすすめ順とは・・・
■区分コード、施設番号による検索の場合■
standard:施設番号順
■経度緯度による検索の場合■
standard:指定された座標から近い順 |
| 18 |
全件返却フラグ |
allReturnFlag |
int(1) |
- |
--- |
条件に該当する情報を全件返却するフラグ。(*1)(*2)
1:全件返却
(*1)緯度経度検索のときのみ有効。
(*2)allReturnFlagが指定されていた場合、pageとhitsは無効になります。 |