ClubReady Api

<back to all web services

StaffListRequest

import Foundation
import ServiceStack

public class StaffListRequest : StaffListRequestDto, 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

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

    /**
    * ClubReady AdminTypeId
    */
    // @ApiMember(DataType="integer", Description="ClubReady AdminTypeId", Name="StaffType", ParameterType="query")
    public var staffType:Int?

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType
    /**
    * Restricts results to staff that are available for scheduling
    */
    // @ApiMember(DataType="bool", Description="Restricts results to staff that are available for scheduling", Name="AvailableForScheduling", ParameterType="query")
    public var availableForScheduling:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case storeId
        case staffType
        case restrictedId
        case restrictedResourceType
        case availableForScheduling
    }

    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)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        staffType = try container.decodeIfPresent(Int.self, forKey: .staffType)
        restrictedId = try container.decodeIfPresent(Int.self, forKey: .restrictedId)
        restrictedResourceType = try container.decodeIfPresent(RestrictedResourceType.self, forKey: .restrictedResourceType)
        availableForScheduling = try container.decodeIfPresent(Bool.self, forKey: .availableForScheduling)
    }

    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 storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if staffType != nil { try container.encode(staffType, forKey: .staffType) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
        if availableForScheduling != nil { try container.encode(availableForScheduling, forKey: .availableForScheduling) }
    }
}

public class StaffListRequestDto : ApiDtoBase
{
    public var staffType:Int?

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

    private enum CodingKeys : String, CodingKey {
        case staffType
    }

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

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

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
}

Swift StaffListRequest DTOs

GET /staff HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv