ClubReady Api

CheckBookingStatusRequest

The following routes are available for this service:
GET	/scheduling/booking-status-check	Determine if a user can book a class.


export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class CheckClassBookingStatusRequestDto extends ApiDtoBase
{
    public ClassScheduleId: number;
    public UserId: number;

    public constructor(init?: Partial<CheckClassBookingStatusRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export 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 ApiKey: string;

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

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

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

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

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<CheckBookingStatusRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ApiResponseBase
{
    public Success: boolean;
    public Message: string;

    public constructor(init?: Partial<ApiResponseBase>) { (Object as any).assign(this, init); }
}

export class CheckBookingStatusResponseDto extends ApiResponseBase
{
    public CanBook: boolean;
    public ConsumesCredit: boolean;
    public Source: string;
    public AvailableCredits: number;
    public IsBooked: boolean;
    public IsWaitListed: boolean;
    public CancelHours: number;
    public LeadTime: number;
    public MaxLeadTime?: number;

    public constructor(init?: Partial<CheckBookingStatusResponseDto>) { super(init); (Object as any).assign(this, init); }
}

export class CheckBookingStatusResponse extends CheckBookingStatusResponseDto
{
    public Success: boolean;
    public Message: string;
    public CanBook: boolean;
    public ConsumesCredit: boolean;
    public Source: string;
    public AvailableCredits: number;
    public IsBooked: boolean;
    public IsWaitListed: boolean;
    public CancelHours: number;
    public LeadTime: number;
    public MaxLeadTime?: number;

    public constructor(init?: Partial<CheckBookingStatusResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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: 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>