GET | /club/guest-pass/get | Get a user's guest pass(es). |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | query | string | Yes | Api Key - grants access to resources |
StoreId | query | integer | Yes | Store ID |
UserId | query | integer | Yes | User ID |
RestrictedId | query | int? | No | |
RestrictedResourceType | query | RestrictedResourceType | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | 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 |
---|---|---|---|---|
Success | form | bool | No | |
Message | form | string | No | |
GuestPasses | form | List<GuestPassSimple> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GuestPasses | form | List<GuestPassSimple> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
Message | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GuestPassId | form | int | No | |
GuestPassTypeId | form | int | No | |
StoreId | form | int | No | |
ActivatedOn | form | DateTime? | No | |
Expires | form | DateTime? | 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 /club/guest-pass/get HTTP/1.1 Host: clubready.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Success":false,"Message":"String","GuestPasses":[{"GuestPassId":0,"GuestPassTypeId":0,"StoreId":0,"ActivatedOn":"0001-01-01T00:00:00.0000000","Expires":"0001-01-01T00:00:00.0000000"}]}