ご契約と料金に関して
ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。
メソッド
- GET
URL
- /api/v2/attr_res
クエリパラメータ
パラメータ名 | 型 | 設定 | 説明 |
---|---|---|---|
offset | 数値 | 任意 | 取得データ開始位置(初期値:0) |
count | 数値 | 任意 | データ取得件数(初期値:100・最大値:100) |
attr_res_id | 文字列 | 任意 | 予約アンケートID |
status | 数値 | 任意 | ステータス(1:必須入力 / 2:任意入力 / 0:管理画面のみ表示) |
form_type | 数値 | 任意 | フォームタイプ(1:テキストボックス(1行) / 2:テキストエリア(複数行) / 3:セレクトボックス(択一選択) / 4:ラジオボタン(択一チェック) / 5:チェックボックス(複数選択) / 9:日付) |
registered_datetime_from | 日付 | 任意 | 登録日時From(yyyy/mm/dd HH:mm:ss 形式) |
registered_datetime_to | 日付 | 任意 | 登録日時To(yyyy/mm/dd HH:mm:ss 形式) |
update_datetime_from | 日付 | 任意 | 最終更新日時From(yyyy/mm/dd HH:mm:ss 形式) |
update_datetime_to | 日付 | 任意 | 最終更新日時To(yyyy/mm/dd HH:mm:ss 形式) |
レスポンス例
ステータスライン / レスポンスヘッダ
- HTTP/1.1 200 OK
- Content-Type:application/json;charset=utf-8
レスポンスボディ
- {
- "total_number": 13,
- "position": {
- "number": 13,
- "from": 1,
- "to": 13
- },
- "results": [
- {
- "attr_res_id": "attr_res1",
- "attr_res_label": "予約アンケートテキストエリア1",
- "status": 2,
- "form_type": 2,
- "form_caption": "",
- "form_length_min": 0,
- "form_length_max": 20,
- "form_format": 0,
- "form_list": "",
- "form_checkall": 0,
- "form_order": 1,
- "registered_datetime": "2023/06/01 15:15:04",
- "update_datetime": "2023/06/01 15:15:04"
- },
- {
- "attr_res_id": "attr_res2",
- "attr_res_label": "予約アンケートテキストエリア2",
- "status": 2,
- "form_type": 2,
- "form_caption": "",
- "form_length_min": 0,
- "form_length_max": 0,
- "form_format": 0,
- "form_list": "",
- "form_checkall": 0,
- "form_order": 4,
- "registered_datetime": "2023/06/02 11:59:21",
- "update_datetime": "2023/06/02 11:59:21"
- }
- ・・・
- ]
- }
予約アンケート 取得項目
取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。
※offsetは0が初期値となります。例:101行目からのデータを取得する場合はoffsetに100を指定します。
キー | 説明 | 型 | 例 | 補足 |
---|---|---|---|---|
total_number | 対象件数 | 数値 | 150 | |
number | 取得件数 | 数値 | 100 | |
from | 開始行 | 数値 | 1 | |
to | 終了行 | 数値 | 100 | |
attr_res_id | 予約アンケートID | 文字列 | attr_res1 | |
attr_res_label | 項目名 | 文字列 | 何が好きですか | |
status | ステータス | 数値 | 1 | 1:必須入力 / 2:任意入力 / 0:管理画面のみ表示 |
form_type | フォームタイプ | 数値 | 1 | 1:テキストボックス(1行) / 2:テキストエリア(複数行) / 3:セレクトボックス(択一選択) / 4:ラジオボタン(択一チェック) / 5:チェックボックス(複数選択) / 6:日付 |
form_caption | 入力項目の説明 | 文字列 | 入力項目の説明です。 | |
form_length_min | 入力文字数 文字以上 | 数値 | 1 | |
form_length_max | 入力文字数 文字以下 | 数値 | 10 | |
form_format | 入力制限 | 数値 | 1 | 0:入力制限しない / 1:英数字と記号(@._- )のみ / 2:英字のみ / 3:数字のみ / 4:ひらがなのみ / 5:カタカナのみ |
form_list | 選択項目 | 文字列 | #りんご#みかん# | |
form_checkall | 初期状態で全チェック | 数値 | 0 | |
form_order | 表示順 | 数値 | 1 | |
registered_datetime | 登録日時 | 日付 | 2023/05/15 10:47:41 | yyyy/mm/dd HH:mm:ss 形式 |
update_datetime | 最終更新日時 | 日付 | 2023/05/24 15:16:59 | yyyy/mm/dd HH:mm:ss 形式 |