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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Scheduling.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class CheckClassBookingStatusRequestDto
        : ApiDtoBase
    {
        public virtual int ClassScheduleId { get; set; }
        public virtual int UserId { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Scheduling.Model
{
    public partial class CheckBookingStatusRequest
        : CheckClassBookingStatusRequestDto, IRestrictedApiRequest
    {
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Chain ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///Store ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///ClubReady Class Schedule ID
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")]
        public virtual int ClassScheduleId { get; set; }

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")]
        public virtual int UserId { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

    public partial class CheckBookingStatusResponse
        : CheckBookingStatusResponseDto
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual bool CanBook { get; set; }
        public virtual bool ConsumesCredit { get; set; }
        public virtual string Source { get; set; }
        public virtual int AvailableCredits { get; set; }
        public virtual bool IsBooked { get; set; }
        public virtual bool IsWaitListed { get; set; }
        public virtual int CancelHours { get; set; }
        public virtual int LeadTime { get; set; }
        public virtual int? MaxLeadTime { get; set; }
    }

    public partial class CheckBookingStatusResponseDto
        : ApiResponseBase
    {
        public virtual bool CanBook { get; set; }
        public virtual bool ConsumesCredit { get; set; }
        public virtual string Source { get; set; }
        public virtual int AvailableCredits { get; set; }
        public virtual bool IsBooked { get; set; }
        public virtual bool IsWaitListed { get; set; }
        public virtual int CancelHours { get; set; }
        public virtual int LeadTime { get; set; }
        public virtual int? MaxLeadTime { get; set; }
    }

}

C# 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>