ClubReady Api

<back to all web services

PackageEligibilityRequest

The following routes are available for this service:
GET/sales/members/{MemberId}/package-eligibilityFind out is a user is eligible to purchase a certain package.
PackageEligibilityRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesStore ID # member belongs to
MemberIdpathintegerYesID of the member to lookup
PackageIdqueryintegerYesID of the package to check
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
PackageEligibilityRequestDto Parameters:
NameParameterData TypeRequiredDescription
PackageIdformintNo
MemberIdformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
PackageEligibilityResponse Parameters:
NameParameterData TypeRequiredDescription
EligibilityInfoformPackageEligibilityNo
PackageEligibilityResponseDto Parameters:
NameParameterData TypeRequiredDescription
EligibilityInfoformPackageEligibilityNo
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
PackageEligibility Parameters:
NameParameterData TypeRequiredDescription
IsEligibleformboolNo
EligibilityformList<PackageEligibilityItem>No
PackageEligibilityItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
IsEligibleformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sales/members/{MemberId}/package-eligibility HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"EligibilityInfo":{"IsEligible":false,"Eligibility":[{"Name":"String","Value":"String","IsEligible":false,"Message":"String"}]},"Success":false,"Message":"String"}