GET | /scheduling/booking-status-events | List of booking status changes in a time frame. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | query | string | Yes | Api Key - grants access to resources |
ChainId | query | integer | No | Chain ID |
StoreId | query | integer | No | Store ID |
FromDate | query | date | Yes | UTC Format |
ToDate | query | date | Yes | Max 24 Hours (UTC Format) |
BookingTypeFilter | query | integer | Yes | 0 = All, 1 = Classes, 2 = Services |
ConsultFilter | query | integer | Yes | 0 = Any, 1 = Only Consults, 2 = Exclude Consults |
StatusFilter | query | integer | No | Leave blank for any, otherwise use ClubReady BookingStatus enum |
RestrictedId | query | int? | No | |
RestrictedResourceType | query | RestrictedResourceType | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FromDate | form | DateTime | No | |
ToDate | form | DateTime | No | |
BookingTypeFilter | form | int | No | |
ConsultFilter | form | int | No | |
StatusFilter | 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 | |
BookingStatusEvents | form | List<BookingStatusEventItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BookingStatusEvents | form | List<BookingStatusEventItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
Message | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ChainId | form | int? | No | |
StoreId | form | int? | No | |
UserId | form | int | No | |
BookingId | form | int | No | |
ClassScheduleId | form | int? | No | |
ServiceId | form | int? | No | |
SessionSizeId | form | int? | No | |
BookingDateTime | form | DateTime | No | |
Status | form | BookingStatus | No | |
StatusId | form | int | No | |
StatusChanged | form | DateTime | No | |
Consult | form | bool | No | |
BookedFromWaitList | form | bool | No |
Name | Value | |
---|---|---|
Undefined | 0 | Undefined |
Unavailable | 1 | Unavailable Periods - Not Bookings |
Open | 2 | Open Booking - Not Yet Logged |
CancelledWithinPolicy | 3 | Cancelled Within Policy Rules - No Session Credit Lost |
CancelledOutsidePolicy | 4 | Cancelled Outside Policy Rules - Session Lost |
Completed | 5 | Completed Booking |
NoShow | 6 | No Show Booking |
RescheduledWithinPolicy | 8 | Rescheduled Within Policy Rules - No Session Credit Lost |
RescheduledByAdmin | 9 | Rescheduled By Admin - Session Lost |
CancelledByAdminNotCustomerFault | 10 | Cancelled By Admin - Not Customer Fault - No Session Credit Lost |
Pending | 11 | Pending |
WaitListed | 12 | WaitListed |
Error | -1 | Error |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /scheduling/booking-status-events HTTP/1.1 Host: clubready.com Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Success":false,"Message":"String","BookingStatusEvents":[{"ChainId":0,"StoreId":0,"UserId":0,"BookingId":0,"ClassScheduleId":0,"ServiceId":0,"SessionSizeId":0,"BookingDateTime":"0001-01-01T00:00:00.0000000","Status":"Undefined","StatusId":0,"StatusChanged":"0001-01-01T00:00:00.0000000","Consult":false,"BookedFromWaitList":false}]}