ClubReady Api

GetGuestPassTypesRequest

The following routes are available for this service:
GET	/club/guest-pass/types	Guest passes available at location.

**GetGuestPassTypesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	No	Either StoreId or ChainId is required
ChainId	query	integer	No	Either StoreId or ChainId is required
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	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

**GetGuestPassTypesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
GuestPassTypes	form	List<GuestPassTypeDto>	No

**GetGuestPassTypesResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
GuestPassTypes	form	List<GuestPassTypeDto>	No

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

**GuestPassTypeDto** Parameters:
Name	Parameter	Data Type	Required
GuestPassTypeId	form	int	No
ChainId	form	int?	No
StoreId	form	int?	No
PassName	form	string	No
DurationDays	form	int	No
ExpirationEditable	form	bool	No
MaxDurationDays	form	int	No
AutoActivateWhenIssued	form	bool	No
IssueBarcodeWhenActivated	form	bool	No
TagWhenActivated	form	string	No
MaxIssuedCount	form	int	No
IsDeleted	form	bool	No
InactiveCount	form	int	No
ActiveCount	form	int	No
ExpiredCount	form	int	No
TotalCount	form	int	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/types HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

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

<GetGuestPassTypesResponse 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>
  <GuestPassTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.ClubAccess.GuestPasses.Dtos" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:GuestPassTypeDto>
      <d2p1:ActiveCount>0</d2p1:ActiveCount>
      <d2p1:AutoActivateWhenIssued>false</d2p1:AutoActivateWhenIssued>
      <d2p1:ChainId>0</d2p1:ChainId>
      <d2p1:DurationDays>0</d2p1:DurationDays>
      <d2p1:ExpirationEditable>false</d2p1:ExpirationEditable>
      <d2p1:ExpiredCount>0</d2p1:ExpiredCount>
      <d2p1:GuestPassTypeId>0</d2p1:GuestPassTypeId>
      <d2p1:InactiveCount>0</d2p1:InactiveCount>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:IssueBarcodeWhenActivated>false</d2p1:IssueBarcodeWhenActivated>
      <d2p1:MaxDurationDays>0</d2p1:MaxDurationDays>
      <d2p1:MaxIssuedCount>0</d2p1:MaxIssuedCount>
      <d2p1:PassName>String</d2p1:PassName>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:TagWhenActivated>String</d2p1:TagWhenActivated>
      <d2p1:TotalCount>0</d2p1:TotalCount>
    </d2p1:GuestPassTypeDto>
  </GuestPassTypes>
</GetGuestPassTypesResponse>