GET | /sales/members/{MemberId}/package-eligibility | Find out is a user is eligible to purchase a certain package. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PackageId | form | int | No | |
MemberId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | form | string | No | |
StoreId | form | int? | No | |
ChainId | form | int? | No |
Store | |
Chain | |
User | |
Undefined |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EligibilityInfo | form | PackageEligibility | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EligibilityInfo | form | PackageEligibility | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
Message | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsEligible | form | bool | No | |
Eligibility | form | List<PackageEligibilityItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: clubready.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"EligibilityInfo":{"IsEligible":false,"Eligibility":[{"Name":"String","Value":"String","IsEligible":false,"Message":"String"}]},"Success":false,"Message":"String"}