ClubReady Api

<back to all web services

CreateClassBookingRequest

The following routes are available for this service:
POST/scheduling/class-bookingCreate a Class Booking
POST/v2/{ApiKey}/club/{StoreId}/booking(obsolete) Create a Class Booking
POST/v2/{ApiKey}/club/{StoreId}/class-booking(obsolete) Create a Class Booking
import Foundation
import ServiceStack

public class CreateClassBookingRequest : CreateClassBookingRequestDto, IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public var apiKey:String

    /**
    * UserID
    */
    // @ApiMember(DataType="string", Description="UserID", IsRequired=true, Name="UserId", ParameterType="query")
    public var userId:Int

    /**
    * Store ID
    */
    // @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
    public var storeId:Int?

    /**
    * Class Schedule ID
    */
    // @ApiMember(DataType="integer", Description="Class Schedule ID", IsRequired=true, Name="ScheduleId", ParameterType="query")
    public var scheduleId:Int

    /**
    * Put user in wait list when possible
    */
    // @ApiMember(DataType="bool", Description="Put user in wait list when possible", Name="AllowWaitList", ParameterType="query")
    public var allowWaitList:Bool

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case userId
        case storeId
        case scheduleId
        case allowWaitList
        case restrictedId
        case restrictedResourceType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
        userId = try container.decodeIfPresent(Int.self, forKey: .userId)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        scheduleId = try container.decodeIfPresent(Int.self, forKey: .scheduleId)
        allowWaitList = try container.decodeIfPresent(Bool.self, forKey: .allowWaitList)
        restrictedId = try container.decodeIfPresent(Int.self, forKey: .restrictedId)
        restrictedResourceType = try container.decodeIfPresent(RestrictedResourceType.self, forKey: .restrictedResourceType)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
        if userId != nil { try container.encode(userId, forKey: .userId) }
        if storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if scheduleId != nil { try container.encode(scheduleId, forKey: .scheduleId) }
        if allowWaitList != nil { try container.encode(allowWaitList, forKey: .allowWaitList) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
    }
}

public class CreateClassBookingRequestDto : ApiDtoBase
{
    public var userId:Int
    public var scheduleId:Int
    public var allowWaitList:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case userId
        case scheduleId
        case allowWaitList
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        userId = try container.decodeIfPresent(Int.self, forKey: .userId)
        scheduleId = try container.decodeIfPresent(Int.self, forKey: .scheduleId)
        allowWaitList = try container.decodeIfPresent(Bool.self, forKey: .allowWaitList)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if userId != nil { try container.encode(userId, forKey: .userId) }
        if scheduleId != nil { try container.encode(scheduleId, forKey: .scheduleId) }
        if allowWaitList != nil { try container.encode(allowWaitList, forKey: .allowWaitList) }
    }
}

public class ApiDtoBase : Codable
{
    public var apiKey:String
    public var storeId:Int?
    public var chainId:Int?

    required public init(){}
}

public enum RestrictedResourceType : String, Codable
{
    case Store
    case Chain
    case User
    case Undefined
}

public class CreateClassBookingResponse : CreateClassBookingResponseDto
{
    public var bookingId:Int?
    public var message:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case bookingId
        case message
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        bookingId = try container.decodeIfPresent(Int.self, forKey: .bookingId)
        message = try container.decodeIfPresent(String.self, forKey: .message)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if bookingId != nil { try container.encode(bookingId, forKey: .bookingId) }
        if message != nil { try container.encode(message, forKey: .message) }
    }
}

public class CreateClassBookingResponseDto : Codable
{
    public var bookingId:Int?
    public var message:String

    required public init(){}
}

Swift CreateClassBookingRequest 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.

POST /scheduling/class-booking HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateClassBookingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <AllowWaitList xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Requests">false</AllowWaitList>
  <ScheduleId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Requests">0</ScheduleId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Requests">0</UserId>
</CreateClassBookingRequest>

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

<CreateClassBookingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <BookingId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</BookingId>
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
</CreateClassBookingResponse>