<back to all web services
GetClassScheduleRequestV2
The following routes are available for this service:| GET | /v2/{Apikey}/club/{StoreID}/classschedule | 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. |
|---|
GetClassScheduleRequestV2 Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| XForwardedFor | header | string | No | IP address of the end user |
| ApiKey | path | string | No | |
| StoreId | path | int? | No | |
| FromDate | query | DateTime? | No | |
| ToDate | query | DateTime? | No | |
| FilterByCategoryId | query | integer | No | Id of CategoryNames 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 |
|---|
| ChainId | form | int? | No | |
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
RestrictedResourceType Enum:| Store | |
| Chain | |
| User | |
| Undefined | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /v2/{Apikey}/club/{StoreID}/classschedule HTTP/1.1
Host: www.clubready.com
Accept: text/csv