Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Guest registration for the classes

Purpose: Use this API to register a guest for a class.

You must specify class_id as path params and mention the following in the body params - Check the body params section for more details.

post/v1/classes/{class_id}/registrations

Path parameters

class_idinteger required

Identifier of a class.

Request body

guest_idstring required

Unique identifier of the guest.

session_idinteger required

Identifier of the session of the class.

center_idstring required

Unique identifier of the center.

waitlistboolean required

Denotes if the guest is to be added to the waitlist. True: Guest to be added to the waitlist. False: Guest is not to be added to the waitlist

notesstring required

Notes on the registration of the guest

booking_sourceinteger required

Denotes the source of the guest's registration of the guest. Website = 0, Webstore = 1, MobileApp = 2, Take5App = 3, and MobilePos = 4.

RegistrationIdinteger

Id of the guest's registration

gender'-1' | '0' | '1' | '3'

Denotes the gender of the guest. NotSpecified = -1, Male = 1, Female = 0, Other = 3.

add_to_allinteger

Denotes the status of add to all.

expandstring[]

(optional) Contains an array of strings to expand the request.

Response

200

OR

Example response

{
  "registrations": [
    {
      "id": 61408,
      "invoice_id": "9e5fc47c-3f8a-4309-a7d6-bbad7cd5bc8c",
      "app_group_id": "c1b5b758-2c08-49e1-9e05-dea182524a9a",
      "group_invoice_id": "50181e14-56c1-492b-970f-181250ea88a9",
      "guest_registrations": [
        {
          "id": 61409,
          "guest_id": "891d852f-7699-48e5-921e-41c1e55a2c24",
          "invoice_id": "84582628-b9e3-4ad9-abf0-5f7abd320754",
          "app_group_id": "716eca8d-559c-492f-94a6-ec1a9175dfff"
        }
      ]
    }
  ]
}