v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve Class Registrations

This API helps you to retrieve a list of registrations for the class sessions.

You must provide the appropriate details in the API request for the class_id, session_id and center_id parameters. Optionally, you can also specify the required expand parameters in the API request. Refer to the Request Parameters table for more information.

get/v1/classes/{class_id}/registrations?session_id={session_id}&center_id={center_id}&expand=session&expand=status_count&page=1&size=10

Path parameters

class_idstring required

Unique identifier of a class.

Query parameters

Session_idstring required

Mandatory Unique session id for which the registrations are to be returned.

Center_idstring required

Mandatory Unique 32 character identifier of the center for the session.

Class_idinteger required

Mandatory Unique identifier of the class.

expandstring

Optional Populates the 'session' objects.

expandstring

Optional Populates the 'status_count' objects.

pageinteger

Optional Number of display page for the records. Default value is 1.

sizeinteger

Optional Number of records displayed per page. Default value is 10.

Response

200

occupancyinteger

{"stackTrail":"paths:/v1/classes/{class_id}/registrations?session_id={session_id}&center_id={center_id}&expand=session&expand=status_count&page=1&size=10:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "registrations": [
    {
      "id": 124920,
      "guest": {
        "id": "29a0fbde-e5e0-494f-8b87-3ae82fe1f0a6",
        "name": "dhanam CMA1"
      },
      "session_id": 91350,
      "indicators": "0@0@0@0@0@0@0@x@0@0@x@x@0",
      "payment_source": "CC Online(amex)",
      "booked_from": "Web",
      "registration_source": "CMA",
      "invoice_id": "9bbac377-20e2-4d33-9156-0d5037224534",
      "appointment_group_id": "7e2b5fa7-55c2-47f3-9330-a46e869c5208",
      "registration_dt": "2021-06-24T21:35:43",
      "notes": "Guest Birthday on: Jun 12, 1990\t\t\t\t\tGuest Birthday on: Jun 12, 1990\t\t\t\t\t",
      "user_code": "560",
      "sort_order": 1,
      "last_updated": "2021-06-24T21:35:43"
    }
  ],
  "session": {
    "id": 91350,
    "name": "VB_Zoom-18May",
    "start_time": "2021-06-25T00:00:00",
    "end_time": "2021-06-25T00:30:00",
    "start_time_utc": "0001-01-01T00:00:00",
    "end_time_utc": "0001-01-01T00:00:00",
    "duration": 30,
    "center_id": "d51712b1-6040-4dd4-abff-cffc9d36f89e",
    "class_id": 11232,
    "instructor_id": "b4ae773a-f805-440f-b968-0f49c014fb02",
    "room_id": "2310a3f6-3769-401c-8162-71f76baa2e26",
    "recurrence_id": 32008,
    "catalog_price": "9000",
    "show_in_catalog": 1,
    "capacity": 10,
    "web_capacity": 5,
    "occupancy": 1,
    "web_occupancy": 1,
    "available_slots": 9,
    "is_open_for_registration": true,
    "service_id": "97e3f904-d94b-417a-b533-5b4a4ddc7b69"
  },
  "status_count": [
    {
      "registered": 37,
      "total": 37,
      "canceled": 36,
      "open": 1,
      "web": 37,
      "occupancy": 1
    }
  ],
  "occupancy": 1,
  "page_details": {
    "total": 37,
    "page": -1,
    "size": 10
  }
}