ClubReady Api

<back to all web services

UserAccountInfoRequest

The following routes are available for this service:
GET/users/{UserId}Get user account summary
import Foundation
import ServiceStack

public class UserAccountInfoRequest : UserAccountInfoRequestDto, 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

    /**
    * (debug id) Jen A = 28975
    */
    // @ApiMember(DataType="integer", Description="(debug id) Jen A = 28975", IsRequired=true, Name="UserId", ParameterType="query")
    public var userId:Int

    /**
    * StoreId OR ChainId is required
    */
    // @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", 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?

    /**
    * Whether you want full detail to be returned or a basic User object. (Format: true|false(default))
    */
    // @ApiMember(DataType="Boolean", Description="Whether you want full detail to be returned or a basic User object. (Format: true|false(default))", Name="FullDetail", ParameterType="query")
    public var fullDetail:Bool

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

public class UserAccountInfoRequestDto : ApiDtoBase
{
    public var userId:Int
    public var fullDetail:Bool

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

    private enum CodingKeys : String, CodingKey {
        case userId
        case fullDetail
    }

    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)
        fullDetail = try container.decodeIfPresent(Bool.self, forKey: .fullDetail)
    }

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

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
}


Swift UserAccountInfoRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users/{UserId} HTTP/1.1 
Host: clubready.com 
Accept: text/jsv