ClubReady Api

CreditDetailRequest

The following routes are available for this service:
GET	/scheduling/{UserId}/credit-detail	Breakdown of a user's credits.

**CreditDetailRequest** 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
FullDetail	query	Boolean	No	Determines if the list of the user's credits are broken out by store ID.
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	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

**CreditDetailResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
TotalPurchased	form	int?	No
TotalAvailable	form	int?	No
Credits	form	List<SessionCreditDetail>	No

**CreditDetailResponseDto** Parameters:
Name	Parameter	Data Type	Required
TotalPurchased	form	int?	No
TotalAvailable	form	int?	No
Credits	form	List<SessionCreditDetail>	No

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

**SessionCreditDetail** Parameters:
Name	Parameter	Data Type	Required
ServiceId	form	int?	No
SessionSizeId	form	int?	No
ClassId	form	int?	No
Name	form	string	No
Total	form	int	No
Available	form	int	No
StoreId	form	int?	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-detail HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<CreditDetailResponse 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>
  <Credits xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <SessionCreditDetail>
      <Available>0</Available>
      <ClassId>0</ClassId>
      <Name>String</Name>
      <ServiceId>0</ServiceId>
      <SessionSizeId>0</SessionSizeId>
      <StoreId>0</StoreId>
      <Total>0</Total>
    </SessionCreditDetail>
  </Credits>
  <TotalAvailable xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TotalAvailable>
  <TotalPurchased xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TotalPurchased>
</CreditDetailResponse>