予約メニュー|メインメニューの取得

予約メニュー|メインメニューの取得

  • 時間タイプ
  • スクールタイプ
  • 会議室タイプ
  • イベントタイプ

ご契約と料金に関して

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

メソッド

  • GET

URL

  • /api/v2/mainmenus

クエリパラメータ

パラメータ名 設定 説明 時間 会議室 スクール イベント
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 形式)

レスポンス例

ステータスライン / レスポンスヘッダ

  • HTTP/1.1 200 OK
  • Content-Type:application/json;charset=utf-8

レスポンスボディ

時間タイプ

  • {
  • "total_number": 2,
  • "position": {
  • "number": 2,
  • "from": 1,
  • "to": 2
  • },
  • "results": [
  • {
  • "main_menu_id": 1,
  • "main_menu_name": "メインメニュー1",
  • "manage_mail1": "test1@xxxx.com",
  • "manage_mail2": "test2@xxxx.com",
  • "manage_mail3": "test3@xxxx.com",
  • "categories": [
  • {
  • "category_id": 12,
  • "category_name": "カテゴリ12"
  • },
  • {
  • "category_id": 11,
  • "category_name": "カテゴリ11"
  • },
  • {
  • "category_id": 10,
  • "category_name": "カテゴリ10"
  • },
  • {
  • "category_id": 8,
  • "category_name": "カテゴリ8"
  • },
  • {
  • "category_id": 7,
  • "category_name": "カテゴリ7"
  • }
  • ],
  • "staff": [],
  • "enable_flg": 1,
  • "manage_only_flg": 0,
  • "unfixed_flg": 0,
  • "event_date": null,
  • "event_start_time": null,
  • "event_end_time": null,
  • "capacity": 999,
  • "group_reservation_flg": 3,
  • "group_reservation_min": 1,
  • "group_reservation_max": 100,
  • "group_reservation_unit": "",
  • "open_week": [
  • {
  • "week": "月"
  • },
  • {
  • "week": "火"
  • },
  • {
  • "week": "水"
  • },
  • {
  • "week": "木"
  • },
  • {
  • "week": "金"
  • },
  • {
  • "week": "土"
  • },
  • {
  • "week": "日"
  • },
  • {
  • "week": "祝日"
  • }
  • ],
  • "start_date": null,
  • "end_date": null,
  • "reception_from_flg": null,
  • "reception_from_date_date": null,
  • "reception_from_date_hour": null,
  • "reception_from_date_minute": null,
  • "reception_from_month_month": null,
  • "reception_from_month_date": null,
  • "reception_from_month_hour": null,
  • "reception_from_month_minute": null,
  • "reception_to_flg": null,
  • "reception_to_time_date": null,
  • "reception_to_time_hour": null,
  • "reception_to_time_minute": null,
  • "reception_to_date_date": null,
  • "reception_to_date_hour": null,
  • "reception_to_date_minute": null,
  • "reception_to_month_month": null,
  • "reception_to_month_date": null,
  • "reception_to_month_hour": null,
  • "reception_to_month_minute": null,
  • "price": 500,
  • "price_note": "料金に関する説明",
  • "list_comment": "",
  • "detail_comment": "<p>紹介コメント</p>\n<p>&nbsp;</p>",
  • "photo_url": "",
  • "detail_url": "https://yoyaku-package.com/detail",
  • "registered_datetime": "2022/03/24 13:17:41",
  • "update_datetime": "2022/03/24 13:17:41",
  • "main_menu_url": ""
  • "form_order": 4
  • },
  • {
  • "main_menu_id": 4,
  • "main_menu_name": "メインメニュー4",
  • "manage_mail1": "",
  • "manage_mail2": "",
  • "manage_mail3": "",
  • "categories": [
  • {
  • "category_id": 1,
  • "category_name": "カテゴリ1"
  • }
  • ],
  • "staff": [],
  • "enable_flg": 1,
  • "manage_only_flg": 0,
  • "unfixed_flg": 0,
  • "event_date": null,
  • "event_start_time": null,
  • "event_end_time": null,
  • "capacity": 100,
  • "group_reservation_flg": 1,
  • "group_reservation_min": 1,
  • "group_reservation_max": 100,
  • "group_reservation_unit": "",
  • "open_week": [
  • {
  • "week": "月"
  • },
  • {
  • "week": "水"
  • },
  • {
  • "week": "金"
  • },
  • {
  • "week": "日"
  • }
  • ],
  • "start_date": "2023/05/28",
  • "end_date": "2025/05/03",
  • "reception_from_flg": null,
  • "reception_from_date_date": null,
  • "reception_from_date_hour": null,
  • "reception_from_date_minute": null,
  • "reception_from_month_month": null,
  • "reception_from_month_date": null,
  • "reception_from_month_hour": null,
  • "reception_from_month_minute": null,
  • "reception_to_flg": null,
  • "reception_to_time_date": null,
  • "reception_to_time_hour": null,
  • "reception_to_time_minute": null,
  • "reception_to_date_date": null,
  • "reception_to_date_hour": null,
  • "reception_to_date_minute": null,
  • "price": 500,
  • "price_note": "料金に関する説明",
  • "list_comment": "",
  • "detail_comment": "<p>紹介コメント</p>\n<p>&nbsp;</p>",
  • "photo_url": "",
  • "detail_url": "https://yoyaku-package.com/detail",
  • "registered_datetime": "2022/03/24 13:17:41",
  • "update_datetime": "2022/03/24 13:17:41",
  • "main_menu_url": ""
  • "form_order": 4
  • }
  • ]
  • }

スクールタイプ

  • {
  • "total_number": 1,
  • "position": {
  • "number": 1,
  • "from": 1,
  • "to": 1
  • },
  • "results": [
  • {
  • "main_menu_id": 2,
  • "main_menu_name": "メインメニュー2",
  • "manage_mail1": "",
  • "manage_mail2": "",
  • "manage_mail3": "",
  • "categories": [],
  • "staff": [],
  • "enable_flg": 1,
  • "manage_only_flg": 0,
  • "unfixed_flg": 0,
  • "event_date": null,
  • "event_start_time": null,
  • "event_end_time": null,
  • "capacity": 20,
  • "group_reservation_flg": 3,
  • "group_reservation_min": 1,
  • "group_reservation_max": 1,
  • "group_reservation_unit": "組",
  • "open_week": [],
  • "start_date": null,
  • "end_date": null,
  • "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,
  • "price": 150,
  • "price_note": "",
  • "list_comment": "",
  • "detail_comment": "",
  • "photo_url": "",
  • "detail_url": "",
  • "registered_datetime": "2022/03/04 14:48:04",
  • "update_datetime": "2022/03/04 14:48:04",
  • "main_menu_url": ""
  • "form_order": 2
  • }
  • ]
  • }

メインメニュー 取得項目

取得件数は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  
      • Related Articles

      • 予約メニュー | 対応予約アンケート(メインメニュー)の取得

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

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

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

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

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