ClubReady Api

<back to all web services

CheckBookingStatusRequest

The following routes are available for this service:
GET/scheduling/booking-status-checkDetermine if a user can book a class.
CheckBookingStatusRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoChain ID
StoreIdqueryintegerNoStore ID
ClassScheduleIdqueryintegerYesClubReady Class Schedule ID
UserIdqueryintegerYesClubReady User ID
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
CheckClassBookingStatusRequestDto Parameters:
NameParameterData TypeRequiredDescription
ClassScheduleIdformintNo
UserIdformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
CheckBookingStatusResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
CanBookformboolNo
ConsumesCreditformboolNo
SourceformstringNo
AvailableCreditsformintNo
IsBookedformboolNo
IsWaitListedformboolNo
CancelHoursformintNo
LeadTimeformintNo
MaxLeadTimeformint?No
CheckBookingStatusResponseDto Parameters:
NameParameterData TypeRequiredDescription
CanBookformboolNo
ConsumesCreditformboolNo
SourceformstringNo
AvailableCreditsformintNo
IsBookedformboolNo
IsWaitListedformboolNo
CancelHoursformintNo
LeadTimeformintNo
MaxLeadTimeformint?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.

GET /scheduling/booking-status-check HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	CanBook: False,
	ConsumesCredit: False,
	Source: String,
	AvailableCredits: 0,
	IsBooked: False,
	IsWaitListed: False,
	CancelHours: 0,
	LeadTime: 0,
	MaxLeadTime: 0
}