予約メニュー | サブメニューの取得

予約メニュー | サブメニューの取得

  • 時間タイプ
  • 会議室タイプ

ご契約と料金に関して

ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。

メソッド

  • GET

URL

  • /api/v2/submenus

クエリパラメータ

パラメータ名 設定 説明
offset 数値 任意 取得データ開始位置(初期値:0)
count 数値 任意 データ取得件数(初期値:100・最大値:100)
sub_menu_id 数値 任意 サブメニューID
enable_flg 数値 任意 ステータス(1:有効、2:無効)
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": 2,
  • "position": {
  • "number": 2,
  • "from": 1,
  • "to": 2
  • },
  • "results": [
  • {
  • "sub_menu_id": 2,
  • "sub_menu_name": "サブメニュー2",
  • "enable_flg": 1,
  • "manage_only_flg": 0,
  • "unfixed_flg": 0,
  • "request_flg": 0,
  • "required_minute": 5,
  • "reservation_time_flg": 0,
  • "reservation_time": "",
  • "reception_from_flg": 1,
  • "reception_from_date_date": 360,
  • "reception_from_date_hour": 0,
  • "reception_from_date_minute": 0,
  • "reception_from_month_month": 0,
  • "reception_from_month_date": 0,
  • "reception_from_month_hour": 0,
  • "reception_from_month_minute": 0,
  • "reception_to_flg": 1,
  • "reception_to_time_date": 0,
  • "reception_to_time_hour": 0,
  • "reception_to_time_minute": 30,
  • "reception_to_date_date": 0,
  • "reception_to_date_hour": 0,
  • "reception_to_date_minute": 0,
  • "reception_to_month_month": 0,
  • "reception_to_month_date": 0,
  • "reception_to_month_hour": 0,
  • "reception_to_month_minute": 0,
  • "price": 500,
  • "form_order": 2,
  • "registered_datetime": "2022/09/21 17:23:34",
  • "update_datetime": "2022/10/24 14:46:54"
  • },
  • {
  • "sub_menu_id": 3,
  • "sub_menu_name": "サブメニュー3",
  • "enable_flg": 1,
  • "manage_only_flg": 0,
  • "unfixed_flg": 0,
  • "request_flg": 0,
  • "required_minute": 15,
  • "reservation_time_flg": 1,
  • "reservation_time": "#12:00#13:00#14:00#",
  • "reception_from_flg": 2,
  • "reception_from_date_date": 0,
  • "reception_from_date_hour": 0,
  • "reception_from_date_minute": 0,
  • "reception_from_month_month": 5,
  • "reception_from_month_date": 10,
  • "reception_from_month_hour": 12,
  • "reception_from_month_minute": 0,
  • "reception_to_flg": 2,
  • "reception_to_time_date": 0,
  • "reception_to_time_hour": 0,
  • "reception_to_time_minute": 30,
  • "reception_to_date_date": 1,
  • "reception_to_date_hour": 13,
  • "reception_to_date_minute": 30,
  • "reception_to_month_month": 0,
  • "reception_to_month_date": 0,
  • "reception_to_month_hour": 0,
  • "reception_to_month_minute": 0,
  • "price": 500,
  • "form_order": 2,
  • "registered_datetime": "2022/10/07 10:51:35",
  • "update_datetime": "2022/10/07 10:51:35"
  • }
  • ]
  • }

サブメニュー 取得項目

取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。

※offsetは0が初期値となります。例:101行目からのデータを取得する場合はoffsetに100を指定します。


キー 説明 補足
total_number 対象件数 数値 150  
number 取得件数 数値 100  
from 開始行 数値 1  
to 終了行 数値 100  
sub_menu_id サブメニューID 数値 1  
sub_menu_name サブメニュー名 文字列 サブメニュー1  
enable_flg ステータス 数値 1 1:有効 / 2:無効
manage_only_flg 管理画面でのみ使用 数値 1 0:予約サイト、管理画面で使用 / 1: 管理画面でのみ使用
unfixed_flg 受付方法 数値 0 0:即時予約 / 1:仮予約
request_flg 抽選モード 数値 0 0:使用しない / 1:使用する
required_minute 所要時間[分] 数値 60  
reservation_time_flg 開始時刻の指定 数値 0 0:使用しない / 1:使用する
reservation_time 開始時刻 文字列 #10:00#11:00#12:00#  
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 料金単価 数値 1500  
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 形式
      • Related Articles

      • 予約メニュー | 対応サブメニューの取得

        時間タイプ 会議室タイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/main_sub_relations クエリパラメータ パラメータ名 型 ...
      • 予約メニュー | 対応予約アンケート(サブメニュー)の取得

        時間タイプ 会議室タイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/sub_attr_res_relations クエリパラメータ ...
      • 予約メニュー | 対応予約オプション(サブメニュー)の取得

        時間タイプ 会議室タイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/sub_option_relations クエリパラメータ パラメータ名 ...
      • 予約メニュー | カテゴリの取得

        時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/categories クエリパラメータ ...
      • 予約メニュー | 予約オプションの取得

        時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/options クエリパラメータ ...