/v1/schedule/class/list

This endpoint makes an HTTP GET request to retrieve the schedule of classes for a specific region, business, and user on a given date range.

Request

Parameters:

id_region (integer): The ID of the region for which the schedule is being requested.

k_business (integer): The ID of the business for which the schedule is being requested.

uid (integer): The user ID for whom the schedule is being requested.

dt_date (string): The start date of the schedule in the format 'YYYY-MM-DD'.

dt_end (string): The end date of the schedule in the format 'YYYY-MM-DD'.

Response

Status: 200

Content-Type: application/json

The response includes the schedule for each date within the specified date range, along with details of each class session, including date, time, duration, location, staff, and virtual options.

The response to the request is in JSON format with the following structure:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "a_calendar": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {}
      }
    },
    "a_session": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dt_date": { "type": "string", "format": "date-time" },
          "dt_time": { "type": "string", "format": "time" },
          "dtl_date": { "type": "string", "format": "date-time" },
          "i_day": { "type": "integer" },
          "i_duration": { "type": "integer" },
          "is_cancel": { "type": "string" },
          "is_event": { "type": "string" },
          "k_class": { "type": "string" },
          "k_class_period": { "type": "string" },
          "k_location": { "type": "string" },
          "s_title": { "type": "string" },
          "text_timezone": { "type": "string" },
          "url_book": { "type": "string", "format": "uri" },
          "a_image": {
            "type": "array",
            "items": {}
          },
          "a_search_tag": {
            "type": "array",
            "items": {}
          },
          "html_description": { "type": "string" },
          "i_book": { "type": "integer" },
          "i_capacity": { "type": "integer" },
          "i_wait": { "type": "integer" },
          "is_wait_list_enabled": { "type": "boolean" },
          "a_staff": {
            "type": "array",
            "items": { "type": "string" }
          },
          "a_virtual_location": {
            "type": "array",
            "items": {}
          },
          "hide_application": { "type": "boolean" },
          "is_virtual": { "type": "boolean" },
          "a_class_tab": {
            "type": "array",
            "items": { "type": "null" }
          }
        },
        "required": ["dt_date", "dt_time", "dtl_date", "i_day", "i_duration", "s_title", "text_timezone", "url_book", "i_capacity"]
      }
    },
    "is_timezone_different": { "type": "boolean" },
    "is_virtual_service": { "type": "boolean" },
    "status": { "type": "string" },
    "s_version": { "type": "string" }
  },
  "required": ["a_calendar", "a_session", "status", "s_version"]
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request

Response

Request

Request samples

Responses

/v1/schedule/class/list

Request#

Response#

Request

Request samples

Responses

Request

Response