ご契約と料金に関して
ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。
メソッド
- GET
URL
- /api/v2/main_attr_res_relations
クエリパラメータ
パラメータ名 | 型 | 設定 | 説明 |
---|---|---|---|
offset | 数値 | 任意 | 取得データ開始位置(初期値:0) |
count | 数値 | 任意 | データ取得件数(初期値:100・最大値:100) |
attr_res_id | 数値 | 任意 | 予約アンケートID |
main_menu_id | 数値 | 任意 | メインメニューID |
レスポンス例
ステータスライン / レスポンスヘッダ
- HTTP/1.1 200 OK
- Content-Type:application/json;charset=utf-8
レスポンスボディ
- {
- "total_number": 31,
- "position": {
- "number": 31,
- "from": 1,
- "to": 31
- },
- "results": [
- {
- "attr_res_id": "attr_res1",
- "main_menu_id": 1
- },
- {
- "attr_res_id": "attr_res2",
- "main_menu_id": 2
- },
- ・・・
- ]
- }
対応予約アンケート(メインメニュー)取得項目
取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。
※offsetは0が初期値となります。例:101行目からのデータを取得する場合はoffsetに100を指定します。
キー | 説明 | 型 | 例 | 補足 |
---|---|---|---|---|
total_number | 対象件数 | 数値 | 150 | |
number | 取得件数 | 数値 | 100 | |
from | 開始行 | 数値 | 1 | |
to | 終了行 | 数値 | 100 | |
attr_res_id | 予約アンケートID | 数値 | 1 | |
main_menu_id | メインメニューID | 数値 | 1 |