ClubReady Api

GetCustomCategoriesUserRequest

The following routes are available for this service:
GET	/users/custom-category	List of a user's items for custom categories.

**GetCustomCategoriesUserRequest** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	No	ClubReady Club ID (StoreID internally)
ChainId	query	integer	No	StoreId OR ChainId is required
UserId	query	integer	Yes	ClubReady User ID
CustomCategoryId	query	integer	No	Custom Category ID
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**GetCustomCategoriesUserRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	int	No
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

**GetCustomCategoriesUserResponse** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	int	No
CustomCategories	form	List<CustomCategoryItemInfo>	No

**GetCustomCategoriesUserResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	int	No
CustomCategories	form	List<CustomCategoryItemInfo>	No

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

**CustomCategoryItemInfo** Parameters:
Name	Parameter	Data Type	Required
CustomCategoryId	form	int	No
CustomCategoryName	form	string	No
CustomCategoryItemId	form	int	No
CustomCategoryItemName	form	string	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 /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>