| GET | /users/date-added | List of users added in a certain date range. |
|---|
import Foundation
import ServiceStack
public class UserListDateAddedRequest : UserListDateAddedRequestDto, 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
/**
* Chain ID
*/
// @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
public var chainId:Int?
/**
* Store ID
*/
// @ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")
public var storeId: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 chainId
case storeId
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)
chainId = try container.decodeIfPresent(Int.self, forKey: .chainId)
storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
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 chainId != nil { try container.encode(chainId, forKey: .chainId) }
if storeId != nil { try container.encode(storeId, forKey: .storeId) }
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 UserListDateAddedRequestDto : 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 UserListDateAddedResponse : UserListDateAddedResponseDto
{
public var users:[ClubClient] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case users
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
users = try container.decodeIfPresent([ClubClient].self, forKey: .users) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if users.count > 0 { try container.encode(users, forKey: .users) }
}
}
public class UserListDateAddedResponseDto : Codable
{
public var users:[ClubClient] = []
required public init(){}
}
public class ClubClient : Codable
{
public var userId:Int
public var username:String
public var firstName:String
public var lastName:String
public var storeId:Int?
public var dateAdded:Date?
public var referredBy:Int?
public var addedBy:Int?
public var referralTypeId:Int?
public var referralTypeName:String
required public init(){}
}
Swift UserListDateAddedRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/date-added HTTP/1.1 Host: clubready.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserListDateAddedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
<Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Users.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
<d2p1:ClubClient>
<d2p1:AddedBy>0</d2p1:AddedBy>
<d2p1:DateAdded>0001-01-01T00:00:00</d2p1:DateAdded>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:ReferralTypeId>0</d2p1:ReferralTypeId>
<d2p1:ReferralTypeName>String</d2p1:ReferralTypeName>
<d2p1:ReferredBy>0</d2p1:ReferredBy>
<d2p1:StoreId>0</d2p1:StoreId>
<d2p1:UserId>0</d2p1:UserId>
<d2p1:Username>String</d2p1:Username>
</d2p1:ClubClient>
</Users>
</UserListDateAddedResponse>