クエリパラメタによる検索条件指定方法
クエリパラメタによる検索条件指定方法¶
本システムの検索条件は全てクエリパラメタで表現することができます。
これにより特定の検索条件(例.女性限定プランかつ一人利用可能で二食付き)を表現したURLを作成することができます。 作成したURLは以下のように活用できます。
- TOPページ部品内で利用
- 外部ホームページに埋め込む
- SNSでシェア
検索パス¶
必ず以下からはじまります。
/provider/search?
クエリパラメタ指定例¶
クエリパラメタは、"パラメタ名=値"という形式で記載します。複数指定する場合は"&"でつなぎます。
# | 条件 | パス |
---|---|---|
1 | 大人=1名、利用日=未定 | /provider/search?un=on&roomUsage=010000000 |
2 | 大人=1名、利用日=2021年9月1日、女性限定 | /provider/search?g=2&fromYear=2021 &fromMonth=9&fromDate=1&toYear=2021&toMonth=9&toDate=1&roomUsage=010000000 |
3 | 大人=1名、利用日=2021年9月1日、二食付き、宿泊プラン | /provider/search?providerType=0&mealType=1&fromYear=2021 &fromMonth=9&fromDate=1&toYear=2021&toMonth=9&toDate=1&roomUsage=010000000 |
4 | 大人=1名、利用日=2021年9月1日、アクティビティ | /provider/search?providerType=1&fromYear=2021 &fromMonth=9&fromDate=1&toYear=2021&toMonth=9&toDate=1&roomUsage=010000000 |
5 | 大人=1名、利用日=2021年9月1日、登山できる宿(st01とする) | /provider/search?st01=1&fromYear=2021 &fromMonth=9&fromDate=1&toYear=2021&toMonth=9&toDate=1&roomUsage=010000000 |
各パラメタの仕様¶
キー | 意味 | 必須 | 説明 |
---|---|---|---|
providerId | 事業者ID | 事業者照会画面の一覧で表示されるid | |
un | 宿泊日未定 | on:未定 それ以外:指定あり | |
fromYear | |||
fromMonth | |||
fromDate | 期間(From) | un=on以外の場合に必須 | |
toYear | |||
toMonth | |||
toDate | 期間(To) | un=on以外の場合に必須 | |
kw | キーワード | 複数の場合は | |
unguest | 利用人数未定 | 必須 | on:未定 それ以外:指定あり |
r | 在庫数 | 必須 | 利用期間の在庫数 |
roomUsage | 部屋別利用人数設定 | unguestがon以外の場合に必須 | 大人人数(2桁)、小学生高学年(2桁) 以下は各1桁(小学生低、幼児A、幼児B、幼児C、幼児D) 大人一人の例)010000000 |
dest | 地域 | 地域マスタの値に従う。複数の場合はカンマ区切りで指定 | |
providerType | 事業者種別 | 0:宿泊 1:体験 | |
mealType | 食事種別(マスタ管理 ) | 1:二食 2:朝食のみ 3:夕食のみ 4:なし 5:三食 6:四食 7:デイBBQ |
|
roomType | 客室様式(マスタ管理 ) | 1:和室, 2:和洋室, 3:シングル 4:ツイン, 5:ダブル, 6:トリプル 7:コテージ・バンガロー等(一棟貸), 8:キャンプサイト, 9:ドミトリー,10:その他 |
|
planId | プランID | プラン照会画面の一覧で表示されるID | |
roomId | 客室タイプID | 客室タイプ照会画面の一覧で表示されるID | |
g | 性別限定 | 0:限定なし 1:男性限定 2:女性限定 3:男性もしくは女性限定 | |
dc | disable children | 子供利用不可 | |
di | disable infant | 幼児利用不可 | |
任意 | 検索タグ |