ClubReady Api

<back to all web services

CreditDetailRequest

The following routes are available for this service:
GET/scheduling/{UserId}/credit-detailBreakdown of a user's credits.
CreditDetailRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoChain ID
StoreIdqueryintegerNoStore ID
UserIdpathintegerYesClubReady User ID
FullDetailqueryBooleanNoDetermines if the list of the user's credits are broken out by store ID.
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
CreditDetailResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
TotalPurchasedformint?No
TotalAvailableformint?No
CreditsformList<SessionCreditDetail>No
CreditDetailResponseDto Parameters:
NameParameterData TypeRequiredDescription
TotalPurchasedformint?No
TotalAvailableformint?No
CreditsformList<SessionCreditDetail>No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
SessionCreditDetail Parameters:
NameParameterData TypeRequiredDescription
ServiceIdformint?No
SessionSizeIdformint?No
ClassIdformint?No
NameformstringNo
TotalformintNo
AvailableformintNo
StoreIdformint?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 /scheduling/{UserId}/credit-detail HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	TotalPurchased: 0,
	TotalAvailable: 0,
	Credits: 
	[
		{
			ServiceId: 0,
			SessionSizeId: 0,
			ClassId: 0,
			Name: String,
			Total: 0,
			Available: 0,
			StoreId: 0
		}
	]
}