| GET | /users/custom-category | List of a user's items for custom categories. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class GetCustomCategoriesUserRequest extends GetCustomCategoriesUserRequestDto implements IRestrictedApiRequest
{
/**
* Api Key - grants access to resources
*/
@ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
public String ApiKey = null;
/**
* ClubReady Club ID (StoreID internally)
*/
@ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")
public Integer StoreId = null;
/**
* StoreId OR ChainId is required
*/
@ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
public Integer ChainId = null;
/**
* ClubReady User ID
*/
@ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
public Integer UserId = null;
/**
* Custom Category ID
*/
@ApiMember(DataType="integer", Description="Custom Category ID", Name="CustomCategoryId", ParameterType="query")
public Integer CustomCategoryId = null;
public Integer RestrictedId = null;
public RestrictedResourceType RestrictedResourceType = null;
public String getApiKey() { return ApiKey; }
public GetCustomCategoriesUserRequest setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public GetCustomCategoriesUserRequest setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getChainId() { return ChainId; }
public GetCustomCategoriesUserRequest setChainId(Integer value) { this.ChainId = value; return this; }
public Integer getUserId() { return UserId; }
public GetCustomCategoriesUserRequest setUserId(Integer value) { this.UserId = value; return this; }
public Integer getCustomCategoryId() { return CustomCategoryId; }
public GetCustomCategoriesUserRequest setCustomCategoryId(Integer value) { this.CustomCategoryId = value; return this; }
public Integer getRestrictedId() { return RestrictedId; }
public GetCustomCategoriesUserRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
public GetCustomCategoriesUserRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
}
public static class GetCustomCategoriesUserRequestDto extends ApiDtoBase
{
public Integer UserId = null;
public Integer CustomCategoryId = null;
public Integer getUserId() { return UserId; }
public GetCustomCategoriesUserRequestDto setUserId(Integer value) { this.UserId = value; return this; }
public Integer getCustomCategoryId() { return CustomCategoryId; }
public GetCustomCategoriesUserRequestDto setCustomCategoryId(Integer value) { this.CustomCategoryId = value; return this; }
}
public static class ApiDtoBase
{
public String ApiKey = null;
public Integer StoreId = null;
public Integer ChainId = null;
public String getApiKey() { return ApiKey; }
public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getChainId() { return ChainId; }
public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
}
public static enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined;
}
public static class GetCustomCategoriesUserResponse extends GetCustomCategoriesUserResponseDto
{
public Integer UserId = null;
public ArrayList<CustomCategoryItemInfo> CustomCategories = null;
public Integer getUserId() { return UserId; }
public GetCustomCategoriesUserResponse setUserId(Integer value) { this.UserId = value; return this; }
public ArrayList<CustomCategoryItemInfo> getCustomCategories() { return CustomCategories; }
public GetCustomCategoriesUserResponse setCustomCategories(ArrayList<CustomCategoryItemInfo> value) { this.CustomCategories = value; return this; }
}
public static class GetCustomCategoriesUserResponseDto extends ApiResponseBase
{
public Integer UserId = null;
public ArrayList<CustomCategoryItemInfo> CustomCategories = null;
public Integer getUserId() { return UserId; }
public GetCustomCategoriesUserResponseDto setUserId(Integer value) { this.UserId = value; return this; }
public ArrayList<CustomCategoryItemInfo> getCustomCategories() { return CustomCategories; }
public GetCustomCategoriesUserResponseDto setCustomCategories(ArrayList<CustomCategoryItemInfo> value) { this.CustomCategories = value; return this; }
}
public static class ApiResponseBase
{
public Boolean Success = null;
public String Message = null;
public Boolean isSuccess() { return Success; }
public ApiResponseBase setSuccess(Boolean value) { this.Success = value; return this; }
public String getMessage() { return Message; }
public ApiResponseBase setMessage(String value) { this.Message = value; return this; }
}
public static class CustomCategoryItemInfo
{
public Integer CustomCategoryId = null;
public String CustomCategoryName = null;
public Integer CustomCategoryItemId = null;
public String CustomCategoryItemName = null;
public Integer getCustomCategoryId() { return CustomCategoryId; }
public CustomCategoryItemInfo setCustomCategoryId(Integer value) { this.CustomCategoryId = value; return this; }
public String getCustomCategoryName() { return CustomCategoryName; }
public CustomCategoryItemInfo setCustomCategoryName(String value) { this.CustomCategoryName = value; return this; }
public Integer getCustomCategoryItemId() { return CustomCategoryItemId; }
public CustomCategoryItemInfo setCustomCategoryItemId(Integer value) { this.CustomCategoryItemId = value; return this; }
public String getCustomCategoryItemName() { return CustomCategoryItemName; }
public CustomCategoryItemInfo setCustomCategoryItemName(String value) { this.CustomCategoryItemName = value; return this; }
}
}
Java GetCustomCategoriesUserRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>