ClubReady Api

<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-scheduleGet Class ScheduleSpecify 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 ScheduleSpecify ToDate/FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today.
GetClassScheduleRequest Parameters:
NameParameterData TypeRequiredDescription
XForwardedForheaderstringNoIP address of the end user
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesStoreID
FromDatequerydateNoFrom Date (if blank, defaults to today; format: YYYY-MM-DD)
ToDatequerydateYesTo Date (max 7 days; format: YYYY-MM-DD)
FilterByCategoryIdqueryintNoId of Category Names to filter results by
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
GetClassScheduleRequestDto Parameters:
NameParameterData TypeRequiredDescription
FromDateformDateTime?No
ToDateformDateTime?No
FilterByCategoryIdformint?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json