ClubReady Api

<back to all web services

GetCustomCategoriesUserRequest

The following routes are available for this service:
GET/users/custom-categoryList of a user's items for custom categories.
import Foundation
import ServiceStack

public class GetCustomCategoriesUserRequest : GetCustomCategoriesUserRequestDto, 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 User ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
    public var userId:Int

    /**
    * Custom Category ID
    */
    // @ApiMember(DataType="integer", Description="Custom Category ID", Name="CustomCategoryId", ParameterType="query")
    public var customCategoryId:Int

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

public class GetCustomCategoriesUserRequestDto : ApiDtoBase
{
    public var userId:Int
    public var customCategoryId:Int

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

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

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

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

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 GetCustomCategoriesUserResponse : GetCustomCategoriesUserResponseDto
{
    public var userId:Int
    public var customCategories:[CustomCategoryItemInfo] = []

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

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

    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)
        customCategories = try container.decodeIfPresent([CustomCategoryItemInfo].self, forKey: .customCategories) ?? []
    }

    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 customCategories.count > 0 { try container.encode(customCategories, forKey: .customCategories) }
    }
}

public class GetCustomCategoriesUserResponseDto : ApiResponseBase
{
    public var userId:Int
    public var customCategories:[CustomCategoryItemInfo] = []

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

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

    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)
        customCategories = try container.decodeIfPresent([CustomCategoryItemInfo].self, forKey: .customCategories) ?? []
    }

    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 customCategories.count > 0 { try container.encode(customCategories, forKey: .customCategories) }
    }
}

public class ApiResponseBase : Codable
{
    public var success:Bool
    public var message:String

    required public init(){}
}

public class CustomCategoryItemInfo : Codable
{
    public var customCategoryId:Int
    public var customCategoryName:String
    public var customCategoryItemId:Int
    public var customCategoryItemName:String

    required public init(){}
}

Swift GetCustomCategoriesUserRequest 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

HTTP + JSON

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

GET /users/custom-category HTTP/1.1 
Host: www.clubready.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"UserId":0,"CustomCategories":[{"CustomCategoryId":0,"CustomCategoryName":"String","CustomCategoryItemId":0,"CustomCategoryItemName":"String"}],"Success":false,"Message":"String"}