ClubReady Api

PackageEligibilityRequest

The following routes are available for this service:
GET	/sales/members/{MemberId}/package-eligibility	Find out is a user is eligible to purchase a certain package.

**PackageEligibilityRequest** 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
StoreId	query	integer	Yes	Store ID # member belongs to
MemberId	path	integer	Yes	ID of the member to lookup
PackageId	query	integer	Yes	ID of the package to check
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**PackageEligibilityRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
PackageId	form	int	No
MemberId	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

**PackageEligibilityResponse** Parameters:
Name	Parameter	Data Type	Required	Description
EligibilityInfo	form	PackageEligibility	No

**PackageEligibilityResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
EligibilityInfo	form	PackageEligibility	No

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

**PackageEligibility** Parameters:
Name	Parameter	Data Type	Required	Description
IsEligible	form	bool	No
Eligibility	form	List<PackageEligibilityItem>	No

**PackageEligibilityItem** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Value	form	string	No
IsEligible	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 /sales/members/{MemberId}/package-eligibility HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

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

<PackageEligibilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.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>
  <EligibilityInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Sales.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:Eligibility>
      <d2p1:PackageEligibilityItem>
        <d2p1:IsEligible>false</d2p1:IsEligible>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:PackageEligibilityItem>
    </d2p1:Eligibility>
    <d2p1:IsEligible>false</d2p1:IsEligible>
  </EligibilityInfo>
</PackageEligibilityResponse>