ご契約と料金に関して
ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。
メソッド
- GET
URL
- /api/v2/timetables
クエリパラメータ
パラメータ名 | 型 | 設定 | 説明 |
---|---|---|---|
offset | 数値 | 任意 | 取得データ開始位置(初期値:0) |
count | 数値 | 任意 | データ取得件数(初期値:100・最大値:100) |
timetable_id | 数値 | 任意 | 時間割ID |
enable_flg | 数値 | 任意 | 公開設定(1:公開、2:非公開) |
timetable_date_from | 日付 | 任意 | 開催日From(yyyy/mm/dd 形式) |
timetable_date_to | 日付 | 任意 | 開催日To(yyyy/mm/dd 形式) |
main_menu_id | 数値 | 任意 | メインメニューID |
staff_id | 数値 | 任意 | 担当ID |
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": 7,
- "position": {
- "number": 7,
- "from": 1,
- "to": 7
- },
- "results": [
- {
- "timetable_id": 1,
- "enable_flg": 1,
- "timetable_date": "2022/03/01",
- "start_time": "12:00",
- "end_time": "13:00",
- "main_menu_id": 1,
- "main_menu_name": "メインメニュー",
- "staff_id": null,
- "staff_name": "",
- "capacity": 99,
- "note": "備考",
- "online_meeting_info": "https://meet.google.com/***-***-***",
- "timetable_url": "https://****.resv.jp/direct.php?direct_id=*",
- "gcalapi_success_flg": 1,
- "registered_datetime": "2022/02/15 10:47:41",
- "update_datetime": "2022/02/24 15:16:59"
- },
- {
- "timetable_id": 6,
- "enable_flg": 2,
- "timetable_date": "2022/04/05",
- "start_time": "12:00",
- "end_time": "13:00",
- "main_menu_id": 3,
- "main_menu_name": "メインメニュー3",
- "staff_id": 1,
- "staff_name": "担当者A",
- "capacity": 30,
- "note": "",
- "online_meeting_info": "",
- "timetable_url": "https://****.resv.jp/direct.php?direct_id=*",
- "gcalapi_success_flg": 0,
- "registered_datetime": "2022/02/25 13:42:45",
- "update_datetime": "2022/02/25 13:42:45"
- },
- ・・・
- ]
- }
時間割 取得項目
取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。
※offsetは0が初期値となります。例:101行目からのデータを取得する場合はoffsetに100を指定します。
キー | 説明 | 型 | 例 | 補足 |
---|---|---|---|---|
total_number | 対象件数 | 数値 | 150 | |
number | 取得件数 | 数値 | 100 | |
from | 開始行 | 数値 | 1 | |
to | 終了行 | 数値 | 100 | |
timetable_id | 時間割ID | 数値 | 1 | |
enable_flg | 公開設定 | 数値 | 1 | 1:公開 / 2:非公開 |
timetable_date | 開催日 | 日付 | 2022/03/01 | yyyy/mm/dd 形式 |
start_time | 開始時間 | 日付 | 12:00 | HH:mm 形式 |
end_time | 終了時間 | 日付 | 13:00 | HH:mm 形式 |
main_menu_id | メインメニューID | 数値 | 1 | |
main_menu_name | メインメニュー名 | 文字列 | メインメニュー1 | |
staff_id | 担当ID | 数値 | 1 | |
staff_name | 担当名 | 文字列 | 担当A | |
capacity | 定員 | 数値 | 10 | |
note | 備考 | 文字列 | 備考 | |
online_meeting_info | Web会議情報 | 文字列 | https://meet.google.com/xxx-yyy-zzz | |
timetable_url | 時間割詳細ページ | 文字列 | https://cus.resv.jp/direct.php?direct_id=1 | URL |
gcalapi_success_flg | 連携ステータス | 数値 | 1 | 1:連携済 |
registered_datetime | 登録日時 | 日付 | 2022/02/15 10:47:41 | yyyy/mm/dd HH:mm:ss 形式 |
update_datetime | 最終更新日時 | 日付 | 2022/02/24 15:16:59 | yyyy/mm/dd HH:mm:ss 形式 |