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 .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/booking-status-check HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CheckBookingStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <AvailableCredits>0</AvailableCredits>
  <CanBook>false</CanBook>
  <CancelHours>0</CancelHours>
  <ConsumesCredit>false</ConsumesCredit>
  <IsBooked>false</IsBooked>
  <IsWaitListed>false</IsWaitListed>
  <LeadTime>0</LeadTime>
  <MaxLeadTime>0</MaxLeadTime>
  <Source>String</Source>
</CheckBookingStatusResponse>