ClubReady Api

GetGuestPassesRequest

The following routes are available for this service:
GET	/club/guest-pass/get	Get a user's guest pass(es).

**GetGuestPassesRequest** 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
UserId	query	integer	Yes	User ID
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**GetGuestPassRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	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

**GetGuestPassesResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
GuestPasses	form	List<GuestPassSimple>	No

**GetGuestPassResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
GuestPasses	form	List<GuestPassSimple>	No

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

**GuestPassSimple** Parameters:
Name	Parameter	Data Type	Required
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 .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 /club/guest-pass/get HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

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

<GetGuestPassesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.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>
  <GuestPasses xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <GuestPassSimple>
      <ActivatedOn>0001-01-01T00:00:00</ActivatedOn>
      <Expires>0001-01-01T00:00:00</Expires>
      <GuestPassId>0</GuestPassId>
      <GuestPassTypeId>0</GuestPassTypeId>
      <StoreId>0</StoreId>
    </GuestPassSimple>
  </GuestPasses>
</GetGuestPassesResponse>