| GET | /users/find/login-details | Verify a user's login details. |
|---|
import Foundation
import ServiceStack
public class UserFindByLoginRequest : UserFindByLoginRequestDto, 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
/**
* ClubReady Club ID (StoreID internally)
*/
// @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")
public var storeId:Int?
/**
* StoreId OR ChainId is required
*/
// @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
public var chainId:Int?
/**
* ClubReady username
*/
// @ApiMember(DataType="string", Description="ClubReady username", IsRequired=true, Name="UserName", ParameterType="query")
public var userName:String
/**
* ClubReady password
*/
// @ApiMember(DataType="string", Description="ClubReady password", IsRequired=true, Name="Password", ParameterType="query")
public var password:String
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 userName
case password
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)
userName = try container.decodeIfPresent(String.self, forKey: .userName)
password = try container.decodeIfPresent(String.self, forKey: .password)
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 userName != nil { try container.encode(userName, forKey: .userName) }
if password != nil { try container.encode(password, forKey: .password) }
if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
}
}
public class UserFindByLoginRequestDto : ApiDtoBase
{
public var userId:Int
public var userName:String
public var password:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case userId
case userName
case password
}
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)
userName = try container.decodeIfPresent(String.self, forKey: .userName)
password = try container.decodeIfPresent(String.self, forKey: .password)
}
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 userName != nil { try container.encode(userName, forKey: .userName) }
if password != nil { try container.encode(password, forKey: .password) }
}
}
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 UserFindByLoginResponse : UserFindByLoginResponseDto
{
public var homeStoreId:Int?
public var userId:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case homeStoreId
case userId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
homeStoreId = try container.decodeIfPresent(Int.self, forKey: .homeStoreId)
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 homeStoreId != nil { try container.encode(homeStoreId, forKey: .homeStoreId) }
if userId != nil { try container.encode(userId, forKey: .userId) }
}
}
public class UserFindByLoginResponseDto : ApiResponseBase
{
public var homeStoreId:Int?
public var userId:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case homeStoreId
case userId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
homeStoreId = try container.decodeIfPresent(Int.self, forKey: .homeStoreId)
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 homeStoreId != nil { try container.encode(homeStoreId, forKey: .homeStoreId) }
if userId != nil { try container.encode(userId, forKey: .userId) }
}
}
public class ApiResponseBase : Codable
{
public var success:Bool
public var message:String
required public init(){}
}
Swift UserFindByLoginRequest 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 /users/find/login-details HTTP/1.1 Host: www.clubready.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
HomeStoreId: 0,
UserId: 0,
Success: False,
Message: String
}