ClubReady Api

CreditCheckRequest

The following routes are available for this service:
GET	/scheduling/{UserId}/credit-check	Check to see if a particular credit can be used to book a certain class or service.

**CreditCheckRequest** 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
ChainId	query	integer	No	Chain ID
StoreId	query	integer	No	Store ID
UserId	path	integer	Yes	ClubReady User ID
CustomerSessionId	query	integer	Yes	ClubReady Customer Session ID
ClassId	query	integer	No	ClubReady Class ID
SessionSizeId	query	integer	No	ClubReady Session Size ID
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**CreditCheckRequestDto** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
CustomerSessionId	form	int	No
ClassId	form	int?	No
SessionSizeId	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

**CreditCheckResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
CanUse	form	bool	No

**CreditCheckResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
CanUse	form	bool	No

**ApiResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	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 /scheduling/{UserId}/credit-check HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreditCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.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>
  <CanUse xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</CanUse>
</CreditCheckResponse>