価格コム WEBサービス API マニュアル

バージョン:1.0
1.ホテルプラン情報取得API
a.リクエスト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件ずつ返します。
パラメータ名 説明 データ型
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
の場合。
結果
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>