ClubReady Api

GetCustomCategoriesRequest

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

**GetCustomCategoriesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Key - grants access to resources
ChainId	query	integer	No	Either StoreId or ChainId is required
StoreId	query	integer	No	Either StoreId or ChainId is required
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**GetCustomCategoriesRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
CustomCategoryId	form	int	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**GetCustomCategoriesResponse** Parameters:
Name	Parameter	Data Type	Required
CustomCategories	form	List<CustomCategoryInfo>	No
Success	form	bool	No
Message	form	string	No

**GetCustomCategoriesResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
CustomCategories	form	List<CustomCategoryInfo>	No

**ApiResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

**CustomCategoryInfo** Parameters:
Name	Parameter	Data Type	Required	Description
ItemCount	form	int	No

**ApiGenericType** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

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: 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>