ClubReady Api

BookingStatusEventsRequest

The following routes are available for this service:
GET	/scheduling/booking-status-events	List of booking status changes in a time frame.

**BookingStatusEventsRequest** Parameters:
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
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

**BookingStatusEventsRequestDto** Parameters:
Name	Parameter	Data Type	Required
FromDate	form	DateTime	No
ToDate	form	DateTime	No
BookingTypeFilter	form	int	No
ConsultFilter	form	int	No
StatusFilter	form	int?	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ChainId	form	int?	No
ApiKey	form	string	No
StoreId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**BookingStatusEventsResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
BookingStatusEvents	form	List<BookingStatusEventItem>	No

**BookingStatusEventsResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
BookingStatusEvents	form	List<BookingStatusEventItem>	No

**ApiResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

**BookingStatusEventItem** Parameters:
Name	Parameter	Data Type	Required
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

**BookingStatus** Enum:
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 .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-events HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BookingStatusEventsResponse 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>
  <BookingStatusEvents xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:BookingStatusEventItem>
      <d2p1:BookedFromWaitList>false</d2p1:BookedFromWaitList>
      <d2p1:BookingDateTime>0001-01-01T00:00:00</d2p1:BookingDateTime>
      <d2p1:BookingId>0</d2p1:BookingId>
      <d2p1:ChainId>0</d2p1:ChainId>
      <d2p1:ClassScheduleId>0</d2p1:ClassScheduleId>
      <d2p1:Consult>false</d2p1:Consult>
      <d2p1:ServiceId>0</d2p1:ServiceId>
      <d2p1:SessionSizeId>0</d2p1:SessionSizeId>
      <d2p1:Status>Undefined</d2p1:Status>
      <d2p1:StatusChanged>0001-01-01T00:00:00</d2p1:StatusChanged>
      <d2p1:StatusId>0</d2p1:StatusId>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:BookingStatusEventItem>
  </BookingStatusEvents>
</BookingStatusEventsResponse>