ClubReady Api

<back to all web services

CreateClassScheduleRequest

The following routes are available for this service:
POST/scheduling/class-scheduleCreate a Class Schedule
CreateClassScheduleRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesStore ID
ClassIdqueryintegerYesClass ID
ClassDateTimequerydate-timeYesDate and Time for Class
TrainerIdqueryintegerNoTrainer ID
AlternateClassNamequerystringNoAlternate Class Name
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
CreateClassScheduleRequestDto Parameters:
NameParameterData TypeRequiredDescription
ClassIdformintNo
ClassDateTimeformDateTimeNo
TrainerIdformint?No
AlternateClassNameformstringNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
CreateClassScheduleResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
ClassScheduleIdformint?No
MessageformstringNo
CreateClassScheduleResponseDto Parameters:
NameParameterData TypeRequiredDescription
ClassScheduleIdformint?No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /scheduling/class-schedule HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	StoreId: 0,
	ClassId: 0,
	ClassDateTime: 0001-01-01,
	TrainerId: 0,
	AlternateClassName: String,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	ClassScheduleId: 0,
	Message: String
}