ClubReady Api

GetCustomCategoriesUserRequest

The following routes are available for this service:
GET	/users/custom-category	List of a user's items for 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 GetCustomCategoriesUserRequestDto extends ApiDtoBase
{
    public UserId: number;
    public CustomCategoryId: number;

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

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

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

    /**
    * ClubReady Club ID (StoreID internally)
    */
    // @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")
    public StoreId?: number;

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

    /**
    * ClubReady User ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
    public UserId: number;

    /**
    * Custom Category ID
    */
    // @ApiMember(DataType="integer", Description="Custom Category ID", Name="CustomCategoryId", ParameterType="query")
    public CustomCategoryId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetCustomCategoriesUserRequest>) { 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 CustomCategoryItemInfo
{
    public CustomCategoryId: number;
    public CustomCategoryName: string;
    public CustomCategoryItemId: number;
    public CustomCategoryItemName: string;

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

export class GetCustomCategoriesUserResponseDto extends ApiResponseBase
{
    public UserId: number;
    public CustomCategories: CustomCategoryItemInfo[];

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

export class GetCustomCategoriesUserResponse extends GetCustomCategoriesUserResponseDto
{
    public UserId: number;
    public CustomCategories: CustomCategoryItemInfo[];

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

TypeScript 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: www.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>