ClubReady Api

GetCustomCategoriesUserRequest

The following routes are available for this service:
GET	/users/custom-category	List of a user's items for custom categories.

import java.math.*
import java.util.*
import net.servicestack.client.*


open 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")
    var ApiKey:String? = null

    /**
    * ClubReady Club ID (StoreID internally)
    */
    @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * StoreId OR ChainId is required
    */
    @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

    /**
    * ClubReady User ID
    */
    @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
    var UserId:Int? = null

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

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class GetCustomCategoriesUserRequestDto : ApiDtoBase()
{
    var UserId:Int? = null
    var CustomCategoryId:Int? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class GetCustomCategoriesUserResponse : GetCustomCategoriesUserResponseDto()
{
    var UserId:Int? = null
    var CustomCategories:ArrayList<CustomCategoryItemInfo> = ArrayList<CustomCategoryItemInfo>()
}

open class GetCustomCategoriesUserResponseDto : ApiResponseBase()
{
    var UserId:Int? = null
    var CustomCategories:ArrayList<CustomCategoryItemInfo> = ArrayList<CustomCategoryItemInfo>()
}

open class ApiResponseBase
{
    var Success:Boolean? = null
    var Message:String? = null
}

open class CustomCategoryItemInfo
{
    var CustomCategoryId:Int? = null
    var CustomCategoryName:String? = null
    var CustomCategoryItemId:Int? = null
    var CustomCategoryItemName:String? = null
}

Kotlin GetCustomCategoriesUserRequest 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/custom-category HTTP/1.1 
Host: clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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