ClubReady Api

<back to all web services

CreditCheckRequest

The following routes are available for this service:
GET/scheduling/{UserId}/credit-checkCheck to see if a particular credit can be used to book a certain class or service.
import Foundation
import ServiceStack

public class CreditCheckRequest : CreditCheckRequestDto, 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

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

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

    /**
    * ClubReady User ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")
    public var userId:Int

    /**
    * ClubReady Customer Session ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady Customer Session ID", IsRequired=true, Name="CustomerSessionId", ParameterType="query")
    public var customerSessionId:Int

    /**
    * ClubReady Class ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady Class ID", Name="ClassId", ParameterType="query")
    public var classId:Int?

    /**
    * ClubReady Session Size ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady Session Size ID", Name="SessionSizeId", ParameterType="query")
    public var sessionSizeId:Int?

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

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

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case chainId
        case storeId
        case userId
        case customerSessionId
        case classId
        case sessionSizeId
        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)
        chainId = try container.decodeIfPresent(Int.self, forKey: .chainId)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        userId = try container.decodeIfPresent(Int.self, forKey: .userId)
        customerSessionId = try container.decodeIfPresent(Int.self, forKey: .customerSessionId)
        classId = try container.decodeIfPresent(Int.self, forKey: .classId)
        sessionSizeId = try container.decodeIfPresent(Int.self, forKey: .sessionSizeId)
        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 chainId != nil { try container.encode(chainId, forKey: .chainId) }
        if storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if userId != nil { try container.encode(userId, forKey: .userId) }
        if customerSessionId != nil { try container.encode(customerSessionId, forKey: .customerSessionId) }
        if classId != nil { try container.encode(classId, forKey: .classId) }
        if sessionSizeId != nil { try container.encode(sessionSizeId, forKey: .sessionSizeId) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
    }
}

public class CreditCheckRequestDto : ApiDtoBase
{
    public var userId:Int
    public var customerSessionId:Int
    public var classId:Int?
    public var sessionSizeId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case userId
        case customerSessionId
        case classId
        case sessionSizeId
    }

    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)
        customerSessionId = try container.decodeIfPresent(Int.self, forKey: .customerSessionId)
        classId = try container.decodeIfPresent(Int.self, forKey: .classId)
        sessionSizeId = try container.decodeIfPresent(Int.self, forKey: .sessionSizeId)
    }

    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 customerSessionId != nil { try container.encode(customerSessionId, forKey: .customerSessionId) }
        if classId != nil { try container.encode(classId, forKey: .classId) }
        if sessionSizeId != nil { try container.encode(sessionSizeId, forKey: .sessionSizeId) }
    }
}

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 CreditCheckResponse : CreditCheckResponseDto
{
    public var success:Bool
    public var message:String
    public var canUse:Bool

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

    private enum CodingKeys : String, CodingKey {
        case success
        case message
        case canUse
    }

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

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

public class CreditCheckResponseDto : ApiResponseBase
{
    public var canUse:Bool

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

    private enum CodingKeys : String, CodingKey {
        case canUse
    }

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

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

public class ApiResponseBase : Codable
{
    public var success:Bool
    public var message:String

    required public init(){}
}

Swift CreditCheckRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /scheduling/{UserId}/credit-check HTTP/1.1 
Host: clubready.com 
Accept: application/json

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

{"Success":false,"Message":"String","CanUse":false}