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.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class BookingStatusEventsRequest extends BookingStatusEventsRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

        /**
        * Chain ID
        */
        @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * Store ID
        */
        @ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * UTC Format
        */
        @ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")
        public Date FromDate = null;

        /**
        * Max 24 Hours (UTC Format)
        */
        @ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")
        public Date ToDate = null;

        /**
        * 0 = All, 1 = Classes, 2 = Services
        */
        @ApiMember(DataType="integer", Description="0 = All, 1 = Classes, 2 = Services", IsRequired=true, Name="BookingTypeFilter", ParameterType="query")
        public Integer BookingTypeFilter = null;

        /**
        * 0 = Any, 1 = Only Consults, 2 = Exclude Consults
        */
        @ApiMember(DataType="integer", Description="0 = Any, 1 = Only Consults, 2 = Exclude Consults", IsRequired=true, Name="ConsultFilter", ParameterType="query")
        public Integer ConsultFilter = null;

        /**
        * Leave blank for any, otherwise use ClubReady BookingStatus enum
        */
        @ApiMember(DataType="integer", Description="Leave blank for any, otherwise use ClubReady BookingStatus enum", Name="StatusFilter", ParameterType="query")
        public Integer StatusFilter = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public BookingStatusEventsRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getChainId() { return ChainId; }
        public BookingStatusEventsRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public BookingStatusEventsRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Date getFromDate() { return FromDate; }
        public BookingStatusEventsRequest setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public BookingStatusEventsRequest setToDate(Date value) { this.ToDate = value; return this; }
        public Integer getBookingTypeFilter() { return BookingTypeFilter; }
        public BookingStatusEventsRequest setBookingTypeFilter(Integer value) { this.BookingTypeFilter = value; return this; }
        public Integer getConsultFilter() { return ConsultFilter; }
        public BookingStatusEventsRequest setConsultFilter(Integer value) { this.ConsultFilter = value; return this; }
        public Integer getStatusFilter() { return StatusFilter; }
        public BookingStatusEventsRequest setStatusFilter(Integer value) { this.StatusFilter = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public BookingStatusEventsRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public BookingStatusEventsRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class BookingStatusEventsRequestDto extends ApiDtoBase
    {
        public Date FromDate = null;
        public Date ToDate = null;
        public Integer BookingTypeFilter = null;
        public Integer ConsultFilter = null;
        public Integer StatusFilter = null;
        
        public Date getFromDate() { return FromDate; }
        public BookingStatusEventsRequestDto setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public BookingStatusEventsRequestDto setToDate(Date value) { this.ToDate = value; return this; }
        public Integer getBookingTypeFilter() { return BookingTypeFilter; }
        public BookingStatusEventsRequestDto setBookingTypeFilter(Integer value) { this.BookingTypeFilter = value; return this; }
        public Integer getConsultFilter() { return ConsultFilter; }
        public BookingStatusEventsRequestDto setConsultFilter(Integer value) { this.ConsultFilter = value; return this; }
        public Integer getStatusFilter() { return StatusFilter; }
        public BookingStatusEventsRequestDto setStatusFilter(Integer value) { this.StatusFilter = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static class BookingStatusEventsResponse extends BookingStatusEventsResponseDto
    {
        public Boolean Success = null;
        public String Message = null;
        public ArrayList<BookingStatusEventItem> BookingStatusEvents = null;
        
        public Boolean isSuccess() { return Success; }
        public BookingStatusEventsResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public BookingStatusEventsResponse setMessage(String value) { this.Message = value; return this; }
        public ArrayList<BookingStatusEventItem> getBookingStatusEvents() { return BookingStatusEvents; }
        public BookingStatusEventsResponse setBookingStatusEvents(ArrayList<BookingStatusEventItem> value) { this.BookingStatusEvents = value; return this; }
    }

    public static class BookingStatusEventsResponseDto extends ApiResponseBase
    {
        public ArrayList<BookingStatusEventItem> BookingStatusEvents = null;
        
        public ArrayList<BookingStatusEventItem> getBookingStatusEvents() { return BookingStatusEvents; }
        public BookingStatusEventsResponseDto setBookingStatusEvents(ArrayList<BookingStatusEventItem> value) { this.BookingStatusEvents = value; return this; }
    }

    public static class ApiResponseBase
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public ApiResponseBase setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ApiResponseBase setMessage(String value) { this.Message = value; return this; }
    }

    public static class BookingStatusEventItem
    {
        public Integer ChainId = null;
        public Integer StoreId = null;
        public Integer UserId = null;
        public Integer BookingId = null;
        public Integer ClassScheduleId = null;
        public Integer ServiceId = null;
        public Integer SessionSizeId = null;
        public Date BookingDateTime = null;
        public BookingStatus Status = null;
        public Integer StatusId = null;
        public Date StatusChanged = null;
        public Boolean Consult = null;
        public Boolean BookedFromWaitList = null;
        
        public Integer getChainId() { return ChainId; }
        public BookingStatusEventItem setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public BookingStatusEventItem setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getUserId() { return UserId; }
        public BookingStatusEventItem setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getBookingId() { return BookingId; }
        public BookingStatusEventItem setBookingId(Integer value) { this.BookingId = value; return this; }
        public Integer getClassScheduleId() { return ClassScheduleId; }
        public BookingStatusEventItem setClassScheduleId(Integer value) { this.ClassScheduleId = value; return this; }
        public Integer getServiceId() { return ServiceId; }
        public BookingStatusEventItem setServiceId(Integer value) { this.ServiceId = value; return this; }
        public Integer getSessionSizeId() { return SessionSizeId; }
        public BookingStatusEventItem setSessionSizeId(Integer value) { this.SessionSizeId = value; return this; }
        public Date getBookingDateTime() { return BookingDateTime; }
        public BookingStatusEventItem setBookingDateTime(Date value) { this.BookingDateTime = value; return this; }
        public BookingStatus getStatus() { return Status; }
        public BookingStatusEventItem setStatus(BookingStatus value) { this.Status = value; return this; }
        public Integer getStatusId() { return StatusId; }
        public BookingStatusEventItem setStatusId(Integer value) { this.StatusId = value; return this; }
        public Date getStatusChanged() { return StatusChanged; }
        public BookingStatusEventItem setStatusChanged(Date value) { this.StatusChanged = value; return this; }
        public Boolean isConsult() { return Consult; }
        public BookingStatusEventItem setConsult(Boolean value) { this.Consult = value; return this; }
        public Boolean isBookedFromWaitList() { return BookedFromWaitList; }
        public BookingStatusEventItem setBookedFromWaitList(Boolean value) { this.BookedFromWaitList = value; return this; }
    }

    public static enum BookingStatus
    {
        Undefined(0),
        Unavailable(1),
        Open(2),
        CancelledWithinPolicy(3),
        CancelledOutsidePolicy(4),
        Completed(5),
        NoShow(6),
        RescheduledWithinPolicy(8),
        RescheduledByAdmin(9),
        CancelledByAdminNotCustomerFault(10),
        Pending(11),
        WaitListed(12),
        Error(-1);

        private final int value;
        BookingStatus(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java BookingStatusEventsRequest DTOs

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>