ClubReady Api

<back to all web services

GetCustomCategoryItemsRequest

The following routes are available for this service:
GET/club/custom-category/itemsList of items for a custom category.
GetCustomCategoryItemsRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoEither StoreId or ChainId is required
StoreIdqueryintegerNoEither StoreId or ChainId is required
CustomCategoryIdqueryintegerYesCustom Category ID
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
GetCustomCategoriesRequestDto Parameters:
NameParameterData TypeRequiredDescription
CustomCategoryIdformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
GetCustomCategoryItemsResponse Parameters:
NameParameterData TypeRequiredDescription
CategoryItemsformList<ApiGenericType>No
GetCustomCategoryItemsResposeDto Parameters:
NameParameterData TypeRequiredDescription
CategoryItemsformList<ApiGenericType>No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ApiGenericType Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
StoreIdformint?No
ChainIdformint?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /club/custom-category/items HTTP/1.1 
Host: www.clubready.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CategoryItems":[{"Id":0,"Name":"String","StoreId":0,"ChainId":0}],"Success":false,"Message":"String"}