ClubReady Api

GetCustomCategoriesRequest

The following routes are available for this service:
GET	/club/custom-category	List of custom categories.


export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class GetCustomCategoriesRequestDto extends ApiDtoBase
{
    public CustomCategoryId: number;

    public constructor(init?: Partial<GetCustomCategoriesRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export 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 ApiKey: string;

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

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

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetCustomCategoriesRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ApiResponseBase
{
    public Success: boolean;
    public Message: string;

    public constructor(init?: Partial<ApiResponseBase>) { (Object as any).assign(this, init); }
}

export class ApiGenericType
{
    public Id: number;
    public Name: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiGenericType>) { (Object as any).assign(this, init); }
}

export class CustomCategoryInfo extends ApiGenericType
{
    public ItemCount: number;

    public constructor(init?: Partial<CustomCategoryInfo>) { super(init); (Object as any).assign(this, init); }
}

export class GetCustomCategoriesResponseDto extends ApiResponseBase
{
    public CustomCategories: CustomCategoryInfo[];

    public constructor(init?: Partial<GetCustomCategoriesResponseDto>) { super(init); (Object as any).assign(this, init); }
}

export class GetCustomCategoriesResponse extends GetCustomCategoriesResponseDto
{
    public CustomCategories: CustomCategoryInfo[];
    public Success: boolean;
    public Message: string;

    public constructor(init?: Partial<GetCustomCategoriesResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetCustomCategoriesRequest 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 /club/custom-category HTTP/1.1 
Host: www.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>