バージョン:1.0
1.ホテルプラン情報取得APIa.リクエストURL
http://yoyaq.com/api/Ver1/HotelPlanSearch/?パラメータ名=パラメータ値・・・・
b.リクエストパラメータ
*パラメータの指定が無い場合は「デフォルト値」となります。
| パラメータ名 | 説明 | データ型 | 値、サンプル | デフォルト値 |
| Latitude | 緯度(日本国内のみ) | Float | (例)35.684 | null |
| Longitude | 経度(日本国内のみ) | Float | (例)139.756 | null |
| Datum | 測地系 (緯度、経度が指定されている時のみ有効) | String | tokyo world |
world |
| CheckIn | チェックイン日(7日先以内の日付で指定してください。) | Integer | YYYYMMDD(例)20061101 | 本日の日付※日付は5:00~29:00を当日とします。 |
| StayCount | 泊数 | Integer | 1~3 | 1 |
| PersonCount | 宿泊人数(1室あたり) | Integer | 1~4 | 2 |
| PriceRangeLower | 予算範囲(下限) | Integer | 0~1000000 | null(下限なし) |
| PriceRangeUpper | 予算範囲(上限) | Integer | 0~1000000 | null(上限なし) |
| RoomCount | 部屋数 | Integer | 1~3 | 1 |
| Prefecture | 都道府県 | String | 別表1 | null |
| SortOrder | ソート順 | String | hotel(ホテル順) pricelower(料金安い順) priceupper(料金高い順) | null |
| PageNum | ページ数(最大50ページまで) | Integer | (例)5 | 1 |
| RoomType | 部屋タイプ | String | ETC(部屋指定なし) SGL(シングル) TWN(ツイン) DBL(ダブル) TPL(トリプル) 4TH(フォース) SUI(スイート) | null |
※別表1 都道府県パラメータ表
| パラメータ値 | 説明 |
| 北海道 | Hokkaido |
| 青森県 | Aomori |
| 岩手県 | Iwate |
| 宮城県 | Miyagi |
| 秋田県 | Akita |
| 山形県 | Yamagata |
| 福島県 | Fukushima |
| 茨城県 | Ibaraki |
| 栃木県 | Tochigi |
| 群馬県 | Gunma |
| 埼玉県 | Saitama |
| 千葉県 | Chiba |
| 東京都 | Tokyo |
| 神奈川県 | Kanagawa |
| 新潟県 | Niigata |
| 富山県 | Toyama |
| 石川県 | Ishikawa |
| 福井県 | Fukui |
| 山梨県 | Yamanashi |
| 長野県 | Nagano |
| 岐阜県 | Gifu |
| 静岡県 | Shizuoka |
| 愛知県 | Aichi |
| 三重県 | Mie |
| 滋賀県 | Shiga |
| 京都府 | Kyoto |
| 大阪府 | Osaka |
| 兵庫県 | Hyogo |
| 奈良県 | Nara |
| 和歌山県 | Wakayama |
| 鳥取県 | Tottori |
| 島根県 | Shimane |
| 岡山県 | Okayama |
| 広島県 | Hiroshima |
| 山口県 | Yamaguchi |
| 徳島県 | Tokushima |
| 香川県 | Kagawa |
| 愛媛県 | Ehime |
| 高知県 | Kochi |
| 福岡県 | Fukuoka |
| 佐賀県 | Saga |
| 長崎県 | Nagasaki |
| 熊本県 | Kumamoto |
| 大分県 | Oita |
| 宮崎県 | Miyazaki |
| 鹿児島県 | Kagoshima |
| 沖縄県 | Okinawa |
c.リターンパラメータ
検索された該当日付の宿泊プラン情報をXML形式で返します。(文字コードはUTF-8)
パラメータ名は大文字小文字を区別し、パラメータ値は大文字小文字の区別はありません。
結果は20件ずつ返します。
パラメータ名は大文字小文字を区別し、パラメータ値は大文字小文字の区別はありません。
結果は20件ずつ返します。
| パラメータ名 | 説明 | データ型 |
| HotelName | ホテル名 | String |
| Address | ホテル住所 | String |
| PlanName | プラン名 | String |
| PlanComment | プランコメント | String |
| HotelURL | ホテル詳細URL | String |
| PlanURL | プラン詳細URL | String |
| RoomPrice | お部屋料金(サービス料、消費税込で一部屋あたりの総額) | Integer |
| DiscountRate | 割引率(%) | Float |
| RoomSize | お部屋の広さ(m2) | Integer |
| Guaranty | お部屋の特徴 | String |
| Latitude | 緯度(世界測地系) | Float |
| Longitude | 経度(世界測地系) | Float |
d.サンプル
リクエスト
※出力結果は日付毎に変動します。
http://yoyaq.com/api/Ver1/HotelPlanSearch/?Prefecture=tokyo&StayCount=1& PersonCount=1&PriceRangeLower=0&PriceRangeUpper=1000000& RoomCount=1&PageNum=1
の場合。
※出力結果は日付毎に変動します。
http://yoyaq.com/api/Ver1/HotelPlanSearch/?Prefecture=tokyo&StayCount=1& PersonCount=1&PriceRangeLower=0&PriceRangeUpper=1000000& RoomCount=1&PageNum=1
の場合。
結果
e.エラー
| エラーコード | 内容 |
| PlanNotFound | 該当するプランがひとつもありませんでした。 |
| TooManyPlansRequested | 制限値を超えたプラン数のリクエストがありました。 |
| InvalidParameterValue | パラメータの値が入っていないか、不正です。 |
| InternalServerError | サーバは、処理を完了できませんでした。 |
PlanNotFoundの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>PlanNotFound</Message>
</Error>
TooManyPlansRequestedの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>TooManyPlansRequested</Message>
</Error>
InvalidParameterValueの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InvalidParameterValue</Message>
</Error>
InternalServerErrorの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InternalServerError</Message>
</Error>

