ご契約と料金に関して
ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。
メソッド
- GET
URL
- /api/v2/staffs
クエリパラメータ
パラメータ名 | 型 | 設定 | 説明 |
---|---|---|---|
offset | 数値 | 任意 | 取得データ開始位置(初期値:0) |
count | 数値 | 任意 | データ取得件数(初期値:100・最大値:100) |
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": 3,
- "position": {
- "number": 3,
- "from": 1,
- "to": 3
- },
- "results": [
- {
- "staff_id": 1,
- "staff_name": "担当者1",
- "enable_flg": 1,
- "form_order": 3,
- "registered_datetime": "2023/06/06 19:14:55",
- "update_datetime": "2023/06/06 19:14:55"
- },
- {
- "staff_id": 2,
- "staff_name": "担当者2",
- "enable_flg": 2,
- "form_order": 2,
- "registered_datetime": "2023/06/06 19:15:15",
- "update_datetime": "2023/06/06 19:15:15"
- }
- ・・・
- ]
- }
担当 取得項目
取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。
※offsetは0が初期値となります。例:101行目からのデータを取得する場合はoffsetに100を指定します。
キー | 説明 | 型 | 例 | 補足 |
---|---|---|---|---|
total_number | 対象件数 | 数値 | 150 | |
number | 取得件数 | 数値 | 100 | |
from | 開始行 | 数値 | 1 | |
to | 終了行 | 数値 | 100 | |
staff_id | 担当ID | 数値 | 1 | |
staff_name | 担当名 | 文字列 | インストラクター1 | |
enable_flg | ステータス | 数値 | 1 | 1:有効 / 2:無効 |
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 形式 |