<back to all web services
GetClassScheduleRequest
Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today.
The following routes are available for this service:| GET | /scheduling/class-schedule | Get Class Schedule | Specify ToDate/FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today. |
|---|
| GET | /v2/{Apikey}/club/{StoreID}/classschedule | (obsolete) Get Class Schedule | Specify ToDate/FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today. |
|---|
GetClassScheduleRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| StoreId | query | integer | Yes | StoreID |
| FromDate | query | date | No | From Date (if blank, defaults to today; format: YYYY-MM-DD) |
| ToDate | query | date | Yes | To Date (max 7 days; format: YYYY-MM-DD) |
| FilterByCategoryId | query | int | No | Id of Category Names to filter results by |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
GetClassScheduleRequestDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| FromDate | form | DateTime? | No | |
| ToDate | form | DateTime? | No | |
| FilterByCategoryId | form | int? | No | |
ApiDtoBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No | |
RestrictedResourceType Enum:| Store | |
| Chain | |
| User | |
| Undefined | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /scheduling/class-schedule HTTP/1.1
Host: clubready.com
Accept: application/xml