ClubReady Api

<back to all web services

GetCustomCategoriesRequest

The following routes are available for this service:
GET/club/custom-categoryList of custom categories.
GetCustomCategoriesRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoEither StoreId or ChainId is required
StoreIdqueryintegerNoEither StoreId or ChainId is required
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
GetCustomCategoriesRequestDto Parameters:
NameParameterData TypeRequiredDescription
CustomCategoryIdformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
GetCustomCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
CustomCategoriesformList<CustomCategoryInfo>No
SuccessformboolNo
MessageformstringNo
GetCustomCategoriesResponseDto Parameters:
NameParameterData TypeRequiredDescription
CustomCategoriesformList<CustomCategoryInfo>No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
CustomCategoryInfo Parameters:
NameParameterData TypeRequiredDescription
ItemCountformintNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CustomCategories: 
	[
		{
			ItemCount: 0,
			Id: 0,
			Name: String,
			StoreId: 0,
			ChainId: 0
		}
	],
	Success: False,
	Message: String
}