| GET | /club/visit-history | Return list of club visits, by club or entire chain. |
|---|
import Foundation
import ServiceStack
public class ClubVisitHistoryRequest : ClubVisitHistoryRequestDto, 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
/**
* Either StoreId or ChainId is required
*/
// @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
public var storeId:Int?
/**
* Either StoreId or ChainId is required
*/
// @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
public var chainId:Int?
/**
* UTC Format
*/
// @ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")
public var fromDate:Date
/**
* Max 24 Hours (UTC Format)
*/
// @ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")
public var toDate:Date
public var restrictedId:Int?
public var restrictedResourceType:RestrictedResourceType
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case apiKey
case storeId
case chainId
case fromDate
case toDate
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)
chainId = try container.decodeIfPresent(Int.self, forKey: .chainId)
fromDate = try container.decodeIfPresent(Date.self, forKey: .fromDate)
toDate = try container.decodeIfPresent(Date.self, forKey: .toDate)
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 chainId != nil { try container.encode(chainId, forKey: .chainId) }
if fromDate != nil { try container.encode(fromDate, forKey: .fromDate) }
if toDate != nil { try container.encode(toDate, forKey: .toDate) }
if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
}
}
public class ClubVisitHistoryRequestDto : ApiDtoBase
{
public var fromDate:Date
public var toDate:Date
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case fromDate
case toDate
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
fromDate = try container.decodeIfPresent(Date.self, forKey: .fromDate)
toDate = try container.decodeIfPresent(Date.self, forKey: .toDate)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if fromDate != nil { try container.encode(fromDate, forKey: .fromDate) }
if toDate != nil { try container.encode(toDate, forKey: .toDate) }
}
}
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 ClubVisitHistoryResponse : ClubVisitHistoryResponseDto
{
public var success:Bool
public var message:String
public var totalVisits:Int
public var visits:[ClubVisitHistoryItem] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case success
case message
case totalVisits
case visits
}
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)
totalVisits = try container.decodeIfPresent(Int.self, forKey: .totalVisits)
visits = try container.decodeIfPresent([ClubVisitHistoryItem].self, forKey: .visits) ?? []
}
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 totalVisits != nil { try container.encode(totalVisits, forKey: .totalVisits) }
if visits.count > 0 { try container.encode(visits, forKey: .visits) }
}
}
public class ClubVisitHistoryResponseDto : ApiResponseBase
{
public var totalVisits:Int
public var visits:[ClubVisitHistoryItem] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case totalVisits
case visits
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
totalVisits = try container.decodeIfPresent(Int.self, forKey: .totalVisits)
visits = try container.decodeIfPresent([ClubVisitHistoryItem].self, forKey: .visits) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if totalVisits != nil { try container.encode(totalVisits, forKey: .totalVisits) }
if visits.count > 0 { try container.encode(visits, forKey: .visits) }
}
}
public class ApiResponseBase : Codable
{
public var success:Bool
public var message:String
required public init(){}
}
public class ClubVisitHistoryItem : Codable
{
public var checkinLogId:Int
public var userId:Int
public var firstName:String
public var lastName:String
public var checkinStoreId:Int
public var checkinLocationName:String
public var homeStoreId:Int
public var homeStoreLocationName:String
public var utcTime:Date
required public init(){}
}
Swift ClubVisitHistoryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /club/visit-history HTTP/1.1 Host: clubready.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Message: String,
TotalVisits: 0,
Visits:
[
{
CheckinLogId: 0,
UserId: 0,
FirstName: String,
LastName: String,
CheckinStoreId: 0,
CheckinLocationName: String,
HomeStoreId: 0,
HomeStoreLocationName: String,
UtcTime: 0001-01-01
}
]
}