get
https://api.zenoti.com/api/Appointments/Admin/Sessions
This API helps you to retrieve the list of class sessions for which the specified guest has registered.
You must provide the appropriate details in the API request for the user_id parameter. Optionally, you can also specify the required details in the API request for several other parameters to filter the search results in the API response. Refer to the Request Parameters table for more information.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Details
| Name | Type | Description |
|---|---|---|
| Success | boolean | Indicates whether the class session registrations of the specified guest was successfully retrieved. |
| results | object | Object that contains detailed information on the class sessions for which the guest has registered. For more information, refer to the results Object table. |
| Centers | object | Object that contains all the elements related to the center in which the guest registered for class sessions. |
| total | int | Total number of class sessions for which the guest has registered. |
| 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 |
|---|---|---|
| Id | int | Unique ID of the class session registration. |
| StartTime | datetime | Starting time of the booked session. |
| EndTime | datetime | Ending time of the booked session. |
| StartTimeUTC | datetime | Starting time of the booked session in UTC. |
| EndTimeUTC | datetime | Ending time of the booked session in UTC. |
| SessionName | string | Name of the class session. |
| RegistrationStatus | enum | Indicates the status of the registration for the class session: Registered = 0, Cancelled = 1, NoShow = 2, SignedIn = 3, Waitlisted = 4, Substituted = 5, ClassCancelled = 6, Closed = 7, Enrolled = 8, Rejected = 9. |
| SessionStatus | enum | Indicates the status of the class session: Active - 0, Cancelled - 1, Upcoming - 2, Inprogress - 3, and Completed - 4. |
| InstructorId | guid | Unique 32-character identifier of the instructor who will perform the class session. |
| Instructor | string | Name of the instructor. |
| ImagePaths | dictionary | Name-value pairs of images that contain pixel sizes and location respectively. |
| Center | string | Name of the center at which the guest has registered for the session. |
| CancellationFeeWindow | int | Number of days within which the guest must pay the cancellation fee for the class. |
| CancellationFee | double | Cancellation fee that the guest must pay for the class. |
| ClassName | string? | Name of the class. |
| ClassDescription | string? | Description of the class. |
| ClassHtmlDescription | string? | Description of the class in HTML. |
| SessionDescription | string? | Description of the registered session. |
| SessionHtmlDescription | string? | Description of the registered session in HTML. |
| CanCancel | boolean | Indicates whether the guest can cancel the booked session. |
| ClassImagePaths | dictionary? | Name-value pairs of class images that contain pixel sizes and location respectively. |
| CurrentWaitlistPosition | int | Current position of the guest on the waiting list for the class session. |
| ClassType | int | Type of the class session. |
| ClassId | int | ID of the class session. |
| ServiceId | guid | Unique 32-character identifier of the class session. |
| CenterId | guid | Unique 32-character identifier of the center. |
| GuestFormStatus | string | Status of the guest's class form details. |
| ClassStartTime | datetime | Starting date and time of the class session. |
| ClassEndTime | datetime | Ending date and time of the class session. |
Error Object
| code | message |
|---|---|
| 502 - InvalidInput | The UserId passed is not of the logged-in guest. |
| 404 - Not Found | Something went wrong. |
| 502 - InvalidInput | Currently more than one sorter is not supported. |
| 502 - InvalidInput | Currently only StartDate is supported as sorter. |
| *** | The date range cannot be more than a month, getting registrations for a month. |