ClubReady Api

<back to all web services

CreateGuestPassRequest

The following routes are available for this service:
POST/club/guest-pass/createCreate a guest pass for a user.
import Foundation
import ServiceStack

public class CreateGuestPassRequest : CreateGuestPassRequestDto, 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

    /**
    * User ID
    */
    // @ApiMember(DataType="string", Description="User ID", 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?

    /**
    * Guest pass type to create.
    */
    // @ApiMember(DataType="integer", Description="Guest pass type to create.", IsRequired=true, Name="GuestPassTypeId", ParameterType="query")
    public var guestPassTypeId:Int

    /**
    * Activate this Guest Pass immediately? (True or False)
    */
    // @ApiMember(DataType="bool", Description="Activate this Guest Pass immediately? (True or False)", IsRequired=true, Name="Activated", ParameterType="query")
    public var activated:Bool

    /**
    * When will this pass expire? (leave blank for never)
    */
    // @ApiMember(DataType="datetime", Description="When will this pass expire? (leave blank for never)", Name="Expires", ParameterType="query")
    public var expires:Date?

    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 guestPassTypeId
        case activated
        case expires
        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)
        guestPassTypeId = try container.decodeIfPresent(Int.self, forKey: .guestPassTypeId)
        activated = try container.decodeIfPresent(Bool.self, forKey: .activated)
        expires = try container.decodeIfPresent(Date.self, forKey: .expires)
        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 guestPassTypeId != nil { try container.encode(guestPassTypeId, forKey: .guestPassTypeId) }
        if activated != nil { try container.encode(activated, forKey: .activated) }
        if expires != nil { try container.encode(expires, forKey: .expires) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
    }
}

public class CreateGuestPassRequestDto : ApiDtoBase
{
    public var userId:Int
    public var guestPassTypeId:Int
    public var activated:Bool
    public var expires:Date?

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

    private enum CodingKeys : String, CodingKey {
        case userId
        case guestPassTypeId
        case activated
        case expires
    }

    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)
        guestPassTypeId = try container.decodeIfPresent(Int.self, forKey: .guestPassTypeId)
        activated = try container.decodeIfPresent(Bool.self, forKey: .activated)
        expires = try container.decodeIfPresent(Date.self, forKey: .expires)
    }

    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 guestPassTypeId != nil { try container.encode(guestPassTypeId, forKey: .guestPassTypeId) }
        if activated != nil { try container.encode(activated, forKey: .activated) }
        if expires != nil { try container.encode(expires, forKey: .expires) }
    }
}

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 CreateGuestPassResponse : CreateGuestPassResponseDto
{
    public var success:Bool
    public var guestPassId:Int
    public var message:String

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

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

    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)
        guestPassId = try container.decodeIfPresent(Int.self, forKey: .guestPassId)
        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 success != nil { try container.encode(success, forKey: .success) }
        if guestPassId != nil { try container.encode(guestPassId, forKey: .guestPassId) }
        if message != nil { try container.encode(message, forKey: .message) }
    }
}

public class CreateGuestPassResponseDto : ApiResponseBase
{
    public var guestPassId:Int

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

    private enum CodingKeys : String, CodingKey {
        case guestPassId
    }

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

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

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

    required public init(){}
}

Swift CreateGuestPassRequest 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 /club/guest-pass/create HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateGuestPassRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.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>
  <Activated xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Activated>
  <Expires xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</Expires>
  <GuestPassTypeId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</GuestPassTypeId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
</CreateGuestPassRequest>

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

<CreateGuestPassResponse 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>
  <GuestPassId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</GuestPassId>
</CreateGuestPassResponse>