v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the class session registrations of a guest

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.

get/api/Appointments/Admin/Sessions

Query parameters

UserIdstring required

Mandatory Unique identifier of the guest for whom you want to retrieve the class session registrations.

startDatestring date

Optional Registered class sessions will be returned from the specified start date. You must specify this date in YYYY-MM-DD format. If you do not provide any time details for this parameter, the API considers its default value: 00:00:00.

endDatestring date

Optional Registered class sessions will be returned until the specified end date. You must specify this date in YYYY-MM-DD format. If you do not provide any time details for this parameter, the API considers its default value: 00:00:00.

CenterIdstring

Optional Unique identifier of the center for which you want to retrieve the guest's registered class sessions.

ClassTypeinteger

Optional Type of the class session.

pageinteger

Optional Current page that you want to view.

sizeinteger

Optional Number of records to be displayed per page.

sortersobject

Optional Object that contains the property for which you want to sort the search results in the API response and whether you want to sort the records in an ascending or descending manner. This parameters contains the following elements: Property and Ascending. Currently, this parameter only supports the values for the startDate parameter.

filtersboolean

Optional Object that contains these additional elements by using which you can filter the records: Property and Value.

Response

200