ClubReady Api

<back to all web services

CreditCheckRequest

The following routes are available for this service:
GET/scheduling/{UserId}/credit-checkCheck to see if a particular credit can be used to book a certain class or service.
CreditCheckRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoChain ID
StoreIdqueryintegerNoStore ID
UserIdpathintegerYesClubReady User ID
CustomerSessionIdqueryintegerYesClubReady Customer Session ID
ClassIdqueryintegerNoClubReady Class ID
SessionSizeIdqueryintegerNoClubReady Session Size ID
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
CreditCheckRequestDto Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
CustomerSessionIdformintNo
ClassIdformint?No
SessionSizeIdformint?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
CreditCheckResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
CanUseformboolNo
CreditCheckResponseDto Parameters:
NameParameterData TypeRequiredDescription
CanUseformboolNo
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

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 /scheduling/{UserId}/credit-check HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	CanUse: False
}