| GET | /scheduling/booking-status-check | Determine if a user can book a class. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| XForwardedFor | header | string | No | IP address of the end user |
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| ChainId | query | integer | No | Chain ID |
| StoreId | query | integer | No | Store ID |
| ClassScheduleId | query | integer | Yes | ClubReady Class Schedule ID |
| UserId | query | integer | Yes | ClubReady User ID |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassScheduleId | form | int | No | |
| UserId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No |
| Store | |
| Chain | |
| User | |
| Undefined |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Message | form | string | No | |
| CanBook | form | bool | No | |
| ConsumesCredit | form | bool | No | |
| Source | form | string | No | |
| AvailableCredits | form | int | No | |
| IsBooked | form | bool | No | |
| IsWaitListed | form | bool | No | |
| CancelHours | form | int | No | |
| LeadTime | form | int | No | |
| MaxLeadTime | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CanBook | form | bool | No | |
| ConsumesCredit | form | bool | No | |
| Source | form | string | No | |
| AvailableCredits | form | int | No | |
| IsBooked | form | bool | No | |
| IsWaitListed | form | bool | No | |
| CancelHours | form | int | No | |
| LeadTime | form | int | No | |
| MaxLeadTime | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>