| POST | /scheduling/class-schedule | Create a Class Schedule |
|---|
| 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 |
| StoreId | query | integer | Yes | Store ID |
| ClassId | query | integer | Yes | Class ID |
| ClassDateTime | query | date-time | Yes | Date and Time for Class |
| TrainerId | query | integer | No | Trainer ID |
| AlternateClassName | query | string | No | Alternate Class Name |
| RestrictedId | body | int? | No | |
| RestrictedResourceType | body | RestrictedResourceType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassId | form | int | No | |
| ClassDateTime | form | DateTime | No | |
| TrainerId | form | int? | No | |
| AlternateClassName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ChainId | form | int? | No | |
| ApiKey | form | string | No | |
| StoreId | form | int? | No |
| Store | |
| Chain | |
| User | |
| Undefined |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| ClassScheduleId | form | int? | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassScheduleId | 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 .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-schedule HTTP/1.1
Host: clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
XForwardedFor: String,
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
}