ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。
| パラメータ名 | 型 | 設定 | 説明 | 時間 | 会議室 | スクール | イベント |
|---|---|---|---|---|---|---|---|
| offset | 数値 | 任意 | 取得データ開始位置(初期値:0) | 〇 | 〇 | 〇 | 〇 |
| count | 数値 | 任意 | データ取得件数(初期値:100・最大値:100) | 〇 | 〇 | 〇 | 〇 |
| main_menu_id | 数値 | 任意 | メインメニューID | 〇 | 〇 | 〇 | 〇 |
| category_id | 数値 | 任意 | カテゴリID | 〇 | 〇 | 〇 | 〇 |
| staff_id | 数値 | 任意 | 担当ID | 〇 | |||
| enable_flg | 数値 | 任意 | ステータス(1:有効、2:無効) | 〇 | 〇 | 〇 | 〇 |
| event_date_from | 日付 | 任意 | 開催日From(yyyy/mm/dd 形式) | 〇 | |||
| event_date_to | 日付 | 任意 | 開催日To(yyyy/mm/dd 形式) | 〇 | |||
| 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 形式) | 〇 | 〇 | 〇 | 〇 |
時間タイプ
スクールタイプ
取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。
※offsetは0が初期値となります。例:101行目からのデータを取得する場合はoffsetに100を指定します。
| キー | 説明 | 型 | 例 | 補足 |
|---|---|---|---|---|
| total_number | 対象件数 | 数値 | 150 | |
| number | 取得件数 | 数値 | 100 | |
| from | 開始行 | 数値 | 1 | |
| to | 終了行 | 数値 | 100 | |
| main_menu_id | メインメニューID | 数値 | 1 | |
| main_menu_name | メインメニュー名 | 文字列 | メインメニュー1 | |
| manage_mail1 | 管理者メールアドレス1 | 文字列 | manage1@xxchoicereservexx.com | |
| manage_mail2 | 管理者メールアドレス2 | 文字列 | manage2@xxchoicereservexx.com | |
| manage_mail3 | 管理者メールアドレス3 | 文字列 | manage3@xxchoicereservexx.com | |
| category_id | カテゴリID | 数値 | 1 | |
| category_name | カテゴリ名 | 文字列 | カテゴリー1 | |
| staff_id | 担当ID | 数値 | 1 | |
| staff_name | 担当名 | 文字列 | 担当A | |
| enable_flg | ステータス | 数値 | 1 | 1:有効 / 2:無効 |
| manage_only_flg | 管理画面でのみ使用 | 数値 | 1 | 0:予約サイト / 管理画面で使用 / 1:管理画面でのみ使用 |
| unfixed_flg | 受付方法 | 数値 | 1 | 0:即時予約 / 1:仮予約 |
| event_date | 開催日 | 日付 | 2022/03/01 | yyyy/mm/dd 形式 |
| event_start_time | 開始時間 | 日付 | 12:00 | HH:mm 形式 |
| event_end_time | 終了時間 | 日付 | 13:00 | HH:mm 形式 |
| capacity | 予約提供数 | 数値 | 10 | |
| group_reservation_flg | 団体予約 | 数値 | 1 | 0: 団体予約をしない / 1:受付ける / 2:管理画面のみ受付ける / 3:受付けない |
| group_reservation_min | 団体予約 最小 | 数値 | 1 | |
| group_reservation_max | 団体予約 最大 | 数値 | 10 | |
| group_reservation_unit | 団体予約時の単位名 | 文字列 | 組 | |
| open_week | 営業曜日 | 文字列 | (レスポンス例参照) | |
| start_date | 公開期間 開始日 | 日付 | 2022/03/01 | yyyy/mm/dd 形式 |
| end_date | 公開期間 終了日 | 日付 | 2022/12/31 | yyyy/mm/dd 形式 |
| reception_from_flg | 受付期間 | 数値 | 1 | 1:日数 / 2:毎月 |
| reception_from_date_date | 日数 日 | 数値 | 180 | |
| reception_from_date_hour | 日数 時 | 数値 | 1 | |
| reception_from_date_minute | 日数 分から受付 | 数値 | 30 | |
| reception_from_month_month | 毎月特定 ヵ月前の | 数値 | 1 | |
| reception_from_month_date | 毎月特定 日 | 数値 | 15 | |
| reception_from_month_hour | 毎月特定 時 | 数値 | 10 | |
| reception_from_month_minute | 毎月特定 分から受付 | 数値 | 30 | |
| reception_to_flg | 受付締切 | 数値 | 1 | 1:予約時間 / 2:予約日 / 3:毎月 |
| reception_to_time_date | 予約時間 日 | 数値 | 2 | |
| reception_to_time_hour | 予約時間 時間 | 数値 | 1 | |
| reception_to_time_minute | 予約時間 分前まで | 数値 | 30 | |
| reception_to_date_date | 予約日 日前 | 数値 | 2 | |
| reception_to_date_hour | 予約日 時 | 数値 | 1 | |
| reception_to_date_minute | 予約日 分まで | 数値 | 30 | |
| reception_to_month_month | 毎月特定 ヵ月前の | 数値 | 1 | |
| reception_to_month_date | 毎月特定 日 | 数値 | 15 | |
| reception_to_month_hour | 毎月特定 時 | 数値 | 10 | |
| reception_to_month_minute | 毎月特定 分で締切 | 数値 | 30 | |
| price | 料金単価 | 数値 | ||
| price_note | 料金に関する説明 | 文字列 | 料金に関する説明です | |
| list_comment | 一覧用紹介コメント | 文字列 | 紹介のコメントです | |
| detail_comment | 紹介コメント | 文字列 | 紹介のコメントです | |
| photo_url | 紹介フォト | 文字列 | https://xxrereservelinkxx.resv.jp/xxx.jpg | |
| detail_url | メニュー詳細URL | 文字列 | https://yychoicereserveyy.jp/detail | |
| registered_datetime | 登録日時 | 日付 | 2022/03/04 14:48:04 | yyyy/mm/dd HH:mm:ss 形式 |
| update_datetime | 最終更新日時 | 日付 | 2022/03/04 14:48:04 | yyyy/mm/dd HH:mm:ss 形式 |
| main_menu_url | メインメニュー詳細ページ | 文字列 | https://xxrereservelinkxx.resv.jp/direct.php?direct_id=1 | メインメニュー詳細画面へのURL(イベントタイプのみ) |
| form_order | 表示順 | 数値 | 1 |