ClubReady Api

<back to all web services

BookingStatusEventsRequest

The following routes are available for this service:
GET/scheduling/booking-status-eventsList of booking status changes in a time frame.
BookingStatusEventsRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoChain ID
StoreIdqueryintegerNoStore ID
FromDatequerydateYesUTC Format
ToDatequerydateYesMax 24 Hours (UTC Format)
BookingTypeFilterqueryintegerYes0 = All, 1 = Classes, 2 = Services
ConsultFilterqueryintegerYes0 = Any, 1 = Only Consults, 2 = Exclude Consults
StatusFilterqueryintegerNoLeave blank for any, otherwise use ClubReady BookingStatus enum
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
BookingStatusEventsRequestDto Parameters:
NameParameterData TypeRequiredDescription
FromDateformDateTimeNo
ToDateformDateTimeNo
BookingTypeFilterformintNo
ConsultFilterformintNo
StatusFilterformint?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
BookingStatusEventsResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
BookingStatusEventsformList<BookingStatusEventItem>No
BookingStatusEventsResponseDto Parameters:
NameParameterData TypeRequiredDescription
BookingStatusEventsformList<BookingStatusEventItem>No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
BookingStatusEventItem Parameters:
NameParameterData TypeRequiredDescription
ChainIdformint?No
StoreIdformint?No
UserIdformintNo
BookingIdformintNo
ClassScheduleIdformint?No
ServiceIdformint?No
SessionSizeIdformint?No
BookingDateTimeformDateTimeNo
StatusformBookingStatusNo
StatusIdformintNo
StatusChangedformDateTimeNo
ConsultformboolNo
BookedFromWaitListformboolNo
BookingStatus Enum:
NameValue
Undefined0Undefined
Unavailable1Unavailable Periods - Not Bookings
Open2Open Booking - Not Yet Logged
CancelledWithinPolicy3Cancelled Within Policy Rules - No Session Credit Lost
CancelledOutsidePolicy4Cancelled Outside Policy Rules - Session Lost
Completed5Completed Booking
NoShow6No Show Booking
RescheduledWithinPolicy8Rescheduled Within Policy Rules - No Session Credit Lost
RescheduledByAdmin9Rescheduled By Admin - Session Lost
CancelledByAdminNotCustomerFault10Cancelled By Admin - Not Customer Fault - No Session Credit Lost
Pending11Pending
WaitListed12WaitListed
Error-1Error

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			Status: Undefined,
			StatusId: 0,
			StatusChanged: 0001-01-01,
			Consult: False,
			BookedFromWaitList: False
		}
	]
}