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.
namespace ClubReady.Core.Api.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type CheckClassBookingStatusRequestDto() = 
        inherit ApiDtoBase()
        member val ClassScheduleId:Int32 = new Int32() with get,set
        member val UserId:Int32 = new Int32() with get,set

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type CheckBookingStatusRequest() = 
        inherit CheckClassBookingStatusRequestDto()
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Chain ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")>]
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Store ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///ClubReady Class Schedule ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="ClubReady Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")>]
        member val ClassScheduleId:Int32 = new Int32() with get,set

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")>]
        member val UserId:Int32 = new Int32() with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set

    [<AllowNullLiteral>]
    type ApiResponseBase() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type CheckBookingStatusResponseDto() = 
        inherit ApiResponseBase()
        member val CanBook:Boolean = new Boolean() with get,set
        member val ConsumesCredit:Boolean = new Boolean() with get,set
        member val Source:String = null with get,set
        member val AvailableCredits:Int32 = new Int32() with get,set
        member val IsBooked:Boolean = new Boolean() with get,set
        member val IsWaitListed:Boolean = new Boolean() with get,set
        member val CancelHours:Int32 = new Int32() with get,set
        member val LeadTime:Int32 = new Int32() with get,set
        member val MaxLeadTime:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type CheckBookingStatusResponse() = 
        inherit CheckBookingStatusResponseDto()
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val CanBook:Boolean = new Boolean() with get,set
        member val ConsumesCredit:Boolean = new Boolean() with get,set
        member val Source:String = null with get,set
        member val AvailableCredits:Int32 = new Int32() with get,set
        member val IsBooked:Boolean = new Boolean() with get,set
        member val IsWaitListed:Boolean = new Boolean() with get,set
        member val CancelHours:Int32 = new Int32() with get,set
        member val LeadTime:Int32 = new Int32() with get,set
        member val MaxLeadTime:Nullable<Int32> = new Nullable<Int32>() with get,set

F# CheckBookingStatusRequest DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Message":"String","CanBook":false,"ConsumesCredit":false,"Source":"String","AvailableCredits":0,"IsBooked":false,"IsWaitListed":false,"CancelHours":0,"LeadTime":0,"MaxLeadTime":0}