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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

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

<GetCustomCategoriesUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <CustomCategories xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <CustomCategoryItemInfo>
      <CustomCategoryId>0</CustomCategoryId>
      <CustomCategoryItemId>0</CustomCategoryItemId>
      <CustomCategoryItemName>String</CustomCategoryItemName>
      <CustomCategoryName>String</CustomCategoryName>
    </CustomCategoryItemInfo>
  </CustomCategories>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
</GetCustomCategoriesUserResponse>