ClubReady Api

<back to all web services

GetGuestPassesRequest

import Foundation
import ServiceStack

public class GetGuestPassesRequest : GetGuestPassRequestDto, 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

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

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

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

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

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

public class GetGuestPassRequestDto : ApiDtoBase
{
    public var userId:Int

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

    private enum CodingKeys : String, CodingKey {
        case userId
    }

    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)
    }

    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) }
    }
}

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 GetGuestPassesResponse : GetGuestPassResponseDto
{
    public var success:Bool
    public var message:String
    public var guestPasses:[GuestPassSimple] = []

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

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

    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)
        guestPasses = try container.decodeIfPresent([GuestPassSimple].self, forKey: .guestPasses) ?? []
    }

    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 guestPasses.count > 0 { try container.encode(guestPasses, forKey: .guestPasses) }
    }
}

public class GetGuestPassResponseDto : ApiResponseBase
{
    public var guestPasses:[GuestPassSimple] = []

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

    private enum CodingKeys : String, CodingKey {
        case guestPasses
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        guestPasses = try container.decodeIfPresent([GuestPassSimple].self, forKey: .guestPasses) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if guestPasses.count > 0 { try container.encode(guestPasses, forKey: .guestPasses) }
    }
}

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

    required public init(){}
}

public class GuestPassSimple : Codable
{
    public var guestPassId:Int
    public var guestPassTypeId:Int
    public var storeId:Int
    public var activatedOn:Date?
    public var expires:Date?

    required public init(){}
}

Swift GetGuestPassesRequest DTOs

GET /club/guest-pass/get HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<GetGuestPassesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.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>
  <GuestPasses xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <GuestPassSimple>
      <ActivatedOn>0001-01-01T00:00:00</ActivatedOn>
      <Expires>0001-01-01T00:00:00</Expires>
      <GuestPassId>0</GuestPassId>
      <GuestPassTypeId>0</GuestPassTypeId>
      <StoreId>0</StoreId>
    </GuestPassSimple>
  </GuestPasses>
</GetGuestPassesResponse>