get https://api.zenoti.com/Appointments/Sessions/40747?SessionId=&StatusString=
This API helps you to retrieve the list of class session registrations in the specified center.
You must provide the appropriate details in the API request for the session_id parameter. Optionally, you can also specify the required details in the API request for the StatusString parameter to filter the search results by registration status in the API response. Refer to the Request Parameters table for more information.
Response Details
| Name | Type | Description |
|---|---|---|
| results | object | Object that contains detailed information on the registered class sessions in the specified center. For more information, refer to the results Object table. |
| Error | object | Object that contains error message and error code details. For more information, refer to the Error Object table. |
results Object
| Name | Type | Description |
|---|---|---|
| UserId | guid | Unique identifier of the guest who has registered for a class session. |
| SessionFK | int | Unique FK identifier of the registered class session. |
| SessionId | int | Unique identifier of the registered class session. |
| RegistrationPK | int | Unique PK identifier of the class session for which the guest was registered. |
| RegistrationId | int | Unique identifier of the class session for which the guest was registered. |
| indicators | string | Unqiue indicators of the class session for which the guest was registered. |
| Name | string | Name of the guest. |
| LogData | string | Data logged for the class session registration. |
| string | Email ID of the guest. | |
| Mobile | string | Mobile number of the guest. |
| PaymentType | string | Method by which the guest paid for the registration of the class session. |
| PaymentSource | string | Source via which the guest paid for the registration of the class session. |
| BalanceBalance | double | Remaining balance after guest made the payment. |
| BookedFrom | enum | Source from which the session was booked. The possible values for this parameter are: 0 = Store, 1 = Mobile, 2 = Web, and 3 = BookingWizardAdvancedMode. |
| IsFree | boolean | Indicates whether the class session can be registered for free. |
| IsFromWaitlist | boolean | Indicates whether the guest belongs to the class session's waitlist. |
| status | enum | Indicates the status of the class session: Active = 0, Cancelled = 1, Upcoming = 2, Inprogress = 3, and Completed = 4. |
| invoiceId | guid | Unique 32-character identifier of the invoice for the class session registration. |
| AppGroupId | guid | Unique 32-character identifier of the App Group for the class session registration. |
| registrationdt | datetime | Date on which the guest registered for the class session. |
| notes | string | Notes added for the guest's class session registration. |
| UserCode | int? | Unique code of the guest. |
| RedemptionType | int? | Type of redemption used by the guest. |
| SortOrder | int | Order by which the center's class session registrations have been sorted. |
| LastUpdated | datetime | Latest date and time on which the center's class session registrations have been updated. |