参照系API：メインメニューの取得 v1

【お知らせ】
2023年6月19日に「ChoiceRESERVE API v2」をリリースしました。
こちらの仕様書をご確認ください。

 ご契約と料金に関して

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

メソッド

• GET

URL

• /api/v1/mainmenus

クエリパラメータ

レスポンス例

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

• 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,
• "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": 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": 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を指定します。

【お知らせ】
今後、仕様変更の予定があり「参照系API：メインメニュー」で取得できる項目のうち、一部は対象外となる可能性があります。詳細は決まり次第、お知らせします。