v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Enroll or register a guest for a class session by an Admin

This API helps you to enroll or register a guest for a class session by an Admin.

You must provide the appropriate details in the API request for the SessionId, GuestId, and BookingSrc parameters. Optionally, you can also specify the required details in the API request for various other parameters to filter the search results in the API response. Refer to the Request Body Parameters table for more information.

post/api/Appointments/Admin/Sessions

Query parameters

SessionIdinteger required

Mandatory ID of the class session to which the guest needs to be registered by an Admin.

GuestIdstring required

Mandatory Unique 32-character identifier of the guest who is to be registered for a class session.

Notesstring

Optional Any notes or comments related to the class session registration of the guest.

Paymentobject

Optional Object that contains all the payment-related elements for the class session registration. For more information, refer to the Payment Object table.

BookingSrc'' required

Mandatory Source from which the class session is to be booked. The possible values for this parameter are: Store - 0, Mobile - 1, Web - 2, BookingWizardAdvancedMode - 3, BookingWizardBottomPanelMode - 4, Queue - 23, Kiosk - 24, KioskCMA - 25, KioskWeb - 26, ClassPass - 43, and FitnessKiosk - 44.

RegistrationIdinteger

Optional ID of the guest's class session registration.

Response

200

Successboolean

RegistrationIdinteger

RegistrationStatusIdinteger

{"stackTrail":"paths:/api/Appointments/Admin/Sessions:post:responses:200:content:application/json:schema:properties:Error","oasType":"schema","type":"unknown"}

Example response

{
  "Success": true,
  "RegistrationId": 1,
  "RegistrationStatusId": 2,
  "MembershipBalance": [
    {
      "MembershipName": "sample string 1",
      "BenefitName": "sample string 2",
      "BenefitId": "28e1ba43-c69d-49f4-8bca-2478a686a39f",
      "Quantity": 1.1,
      "Frequency": "sample string 4",
      "ExpirationDays": 1,
      "Used": 1.1,
      "Notes": "sample string 5",
      "AllowDirectBooking": true,
      "HasEquivalents": true,
      "Balance": 1.1,
      "IsCategory": true,
      "PeakDiscount": 7,
      "OffPeakDiscount": 8,
      "PostCreditPeakDiscount": 9,
      "PostCreditOffPeakDiscount": 10,
      "AllServices": true,
      "IsAddOn": true
    }
  ]
}