POST | /club/guest-pass/activate | Activate a guest pass. |
---|
import Foundation
import ServiceStack
public class ActivateGuestPassRequest : ActivateGuestPassRequestDto, 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?
/**
* Guest pass to activate.
*/
// @ApiMember(DataType="integer", Description="Guest pass to activate.", IsRequired=true, Name="GuestPassId", ParameterType="query")
public var guestPassId:Int
/**
* 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 storeId
case guestPassId
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)
storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
guestPassId = try container.decodeIfPresent(Int.self, forKey: .guestPassId)
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 storeId != nil { try container.encode(storeId, forKey: .storeId) }
if guestPassId != nil { try container.encode(guestPassId, forKey: .guestPassId) }
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 ActivateGuestPassRequestDto : ApiDtoBase
{
public var guestPassId:Int
public var expires:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case guestPassId
case expires
}
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)
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 guestPassId != nil { try container.encode(guestPassId, forKey: .guestPassId) }
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 ActivateGuestPassResponse : ActivateGuestPassResponseDto
{
public var success:Bool
public var message:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case success
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)
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 message != nil { try container.encode(message, forKey: .message) }
}
}
public class ActivateGuestPassResponseDto : ApiResponseBase
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class ApiResponseBase : Codable
{
public var success:Bool
public var message:String
required public init(){}
}
Swift ActivateGuestPassRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /club/guest-pass/activate HTTP/1.1
Host: clubready.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ApiKey":"String","StoreId":0,"GuestPassId":0,"Expires":"0001-01-01T00:00:00.0000000","RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Success":false,"Message":"String"}