| POST | /scheduling/class-booking | Create a Class Booking | |
|---|---|---|---|
| POST | /v2/{ApiKey}/club/{StoreId}/booking | (obsolete) Create a Class Booking | |
| POST | /v2/{ApiKey}/club/{StoreId}/class-booking | (obsolete) Create a Class Booking |
| 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 |
| UserId | query | string | Yes | UserID |
| StoreId | query | integer | Yes | Store ID |
| ScheduleId | query | integer | Yes | Class Schedule ID |
| AllowWaitList | query | bool | No | Put user in wait list when possible |
| RestrictedId | body | int? | No | |
| RestrictedResourceType | body | RestrictedResourceType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | int | No | |
| ScheduleId | form | int | No | |
| AllowWaitList | form | bool | 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 |
|---|---|---|---|---|
| BookingId | form | int? | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BookingId | form | int? | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /scheduling/class-booking HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
XForwardedFor: String,
ApiKey: String,
UserId: 0,
StoreId: 0,
ScheduleId: 0,
AllowWaitList: False,
RestrictedId: 0,
RestrictedResourceType: Store,
ChainId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
BookingId: 0,
Message: String
}