ClubReady Api

<back to all web services

GetCustomCategoriesRequest

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

public class dtos
{

    public static class GetCustomCategoriesRequest extends GetCustomCategoriesRequestDto 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;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetCustomCategoriesRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GetCustomCategoriesRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetCustomCategoriesRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetCustomCategoriesRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetCustomCategoriesRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class GetCustomCategoriesRequestDto extends ApiDtoBase
    {
        public Integer CustomCategoryId = null;
        
        public Integer getCustomCategoryId() { return CustomCategoryId; }
        public GetCustomCategoriesRequestDto 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 GetCustomCategoriesResponse extends GetCustomCategoriesResponseDto
    {
        public ArrayList<CustomCategoryInfo> CustomCategories = null;
        public Boolean Success = null;
        public String Message = null;
        
        public ArrayList<CustomCategoryInfo> getCustomCategories() { return CustomCategories; }
        public GetCustomCategoriesResponse setCustomCategories(ArrayList<CustomCategoryInfo> value) { this.CustomCategories = value; return this; }
        public Boolean isSuccess() { return Success; }
        public GetCustomCategoriesResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public GetCustomCategoriesResponse setMessage(String value) { this.Message = value; return this; }
    }

    public static class GetCustomCategoriesResponseDto extends ApiResponseBase
    {
        public ArrayList<CustomCategoryInfo> CustomCategories = null;
        
        public ArrayList<CustomCategoryInfo> getCustomCategories() { return CustomCategories; }
        public GetCustomCategoriesResponseDto setCustomCategories(ArrayList<CustomCategoryInfo> 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 CustomCategoryInfo extends ApiGenericType
    {
        public Integer ItemCount = null;
        
        public Integer getItemCount() { return ItemCount; }
        public CustomCategoryInfo setItemCount(Integer value) { this.ItemCount = value; return this; }
    }

    public static class ApiGenericType
    {
        public Integer Id = null;
        public String Name = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public Integer getId() { return Id; }
        public ApiGenericType setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ApiGenericType setName(String value) { this.Name = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiGenericType setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiGenericType setChainId(Integer value) { this.ChainId = value; return this; }
    }

}

Java GetCustomCategoriesRequest DTOs

GET /club/custom-category HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<GetCustomCategoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Club.Models">
  <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">
    <CustomCategoryInfo>
      <ChainId>0</ChainId>
      <Id>0</Id>
      <Name>String</Name>
      <StoreId>0</StoreId>
      <ItemCount>0</ItemCount>
    </CustomCategoryInfo>
  </CustomCategories>
</GetCustomCategoriesResponse>