ClubReady Api

<back to all web services

CheckBookingStatusRequest

The following routes are available for this service:
GET/scheduling/booking-status-checkDetermine if a user can book a class.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CheckBookingStatusRequest extends CheckClassBookingStatusRequestDto 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;

        /**
        * ClubReady Class Schedule ID
        */
        @ApiMember(DataType="integer", Description="ClubReady Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")
        public Integer ClassScheduleId = null;

        /**
        * ClubReady User ID
        */
        @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
        public Integer UserId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public CheckBookingStatusRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getChainId() { return ChainId; }
        public CheckBookingStatusRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public CheckBookingStatusRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getClassScheduleId() { return ClassScheduleId; }
        public CheckBookingStatusRequest setClassScheduleId(Integer value) { this.ClassScheduleId = value; return this; }
        public Integer getUserId() { return UserId; }
        public CheckBookingStatusRequest setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public CheckBookingStatusRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public CheckBookingStatusRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class CheckClassBookingStatusRequestDto extends ApiDtoBase
    {
        public Integer ClassScheduleId = null;
        public Integer UserId = null;
        
        public Integer getClassScheduleId() { return ClassScheduleId; }
        public CheckClassBookingStatusRequestDto setClassScheduleId(Integer value) { this.ClassScheduleId = value; return this; }
        public Integer getUserId() { return UserId; }
        public CheckClassBookingStatusRequestDto setUserId(Integer value) { this.UserId = 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 CheckBookingStatusResponse extends CheckBookingStatusResponseDto
    {
        public Boolean Success = null;
        public String Message = null;
        public Boolean CanBook = null;
        public Boolean ConsumesCredit = null;
        public String Source = null;
        public Integer AvailableCredits = null;
        public Boolean IsBooked = null;
        public Boolean IsWaitListed = null;
        public Integer CancelHours = null;
        public Integer LeadTime = null;
        public Integer MaxLeadTime = null;
        
        public Boolean isSuccess() { return Success; }
        public CheckBookingStatusResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public CheckBookingStatusResponse setMessage(String value) { this.Message = value; return this; }
        public Boolean isCanBook() { return CanBook; }
        public CheckBookingStatusResponse setCanBook(Boolean value) { this.CanBook = value; return this; }
        public Boolean isConsumesCredit() { return ConsumesCredit; }
        public CheckBookingStatusResponse setConsumesCredit(Boolean value) { this.ConsumesCredit = value; return this; }
        public String getSource() { return Source; }
        public CheckBookingStatusResponse setSource(String value) { this.Source = value; return this; }
        public Integer getAvailableCredits() { return AvailableCredits; }
        public CheckBookingStatusResponse setAvailableCredits(Integer value) { this.AvailableCredits = value; return this; }
        public Boolean getIsBooked() { return IsBooked; }
        public CheckBookingStatusResponse setIsBooked(Boolean value) { this.IsBooked = value; return this; }
        public Boolean getIsWaitListed() { return IsWaitListed; }
        public CheckBookingStatusResponse setIsWaitListed(Boolean value) { this.IsWaitListed = value; return this; }
        public Integer getCancelHours() { return CancelHours; }
        public CheckBookingStatusResponse setCancelHours(Integer value) { this.CancelHours = value; return this; }
        public Integer getLeadTime() { return LeadTime; }
        public CheckBookingStatusResponse setLeadTime(Integer value) { this.LeadTime = value; return this; }
        public Integer getMaxLeadTime() { return MaxLeadTime; }
        public CheckBookingStatusResponse setMaxLeadTime(Integer value) { this.MaxLeadTime = value; return this; }
    }

    public static class CheckBookingStatusResponseDto extends ApiResponseBase
    {
        public Boolean CanBook = null;
        public Boolean ConsumesCredit = null;
        public String Source = null;
        public Integer AvailableCredits = null;
        public Boolean IsBooked = null;
        public Boolean IsWaitListed = null;
        public Integer CancelHours = null;
        public Integer LeadTime = null;
        public Integer MaxLeadTime = null;
        
        public Boolean isCanBook() { return CanBook; }
        public CheckBookingStatusResponseDto setCanBook(Boolean value) { this.CanBook = value; return this; }
        public Boolean isConsumesCredit() { return ConsumesCredit; }
        public CheckBookingStatusResponseDto setConsumesCredit(Boolean value) { this.ConsumesCredit = value; return this; }
        public String getSource() { return Source; }
        public CheckBookingStatusResponseDto setSource(String value) { this.Source = value; return this; }
        public Integer getAvailableCredits() { return AvailableCredits; }
        public CheckBookingStatusResponseDto setAvailableCredits(Integer value) { this.AvailableCredits = value; return this; }
        public Boolean getIsBooked() { return IsBooked; }
        public CheckBookingStatusResponseDto setIsBooked(Boolean value) { this.IsBooked = value; return this; }
        public Boolean getIsWaitListed() { return IsWaitListed; }
        public CheckBookingStatusResponseDto setIsWaitListed(Boolean value) { this.IsWaitListed = value; return this; }
        public Integer getCancelHours() { return CancelHours; }
        public CheckBookingStatusResponseDto setCancelHours(Integer value) { this.CancelHours = value; return this; }
        public Integer getLeadTime() { return LeadTime; }
        public CheckBookingStatusResponseDto setLeadTime(Integer value) { this.LeadTime = value; return this; }
        public Integer getMaxLeadTime() { return MaxLeadTime; }
        public CheckBookingStatusResponseDto setMaxLeadTime(Integer value) { this.MaxLeadTime = 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; }
    }

}

Java CheckBookingStatusRequest 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-check HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

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

<CheckBookingStatusResponse 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>
  <AvailableCredits>0</AvailableCredits>
  <CanBook>false</CanBook>
  <CancelHours>0</CancelHours>
  <ConsumesCredit>false</ConsumesCredit>
  <IsBooked>false</IsBooked>
  <IsWaitListed>false</IsWaitListed>
  <LeadTime>0</LeadTime>
  <MaxLeadTime>0</MaxLeadTime>
  <Source>String</Source>
</CheckBookingStatusResponse>