ClubReady Api

CreateGuestPassRequest

The following routes are available for this service:
POST	/club/guest-pass/create	Create a guest pass for a user.

**CreateGuestPassRequest** 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
UserId	query	string	Yes	User ID
StoreId	query	integer	Yes	Store ID
GuestPassTypeId	query	integer	Yes	Guest pass type to create.
Activated	query	bool	Yes	Activate this Guest Pass immediately? (True or False)
Expires	query	datetime	No	When will this pass expire? (leave blank for never)
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**CreateGuestPassRequestDto** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
GuestPassTypeId	form	int	No
Activated	form	bool	No
Expires	form	DateTime?	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

**CreateGuestPassResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
GuestPassId	form	int	No
Message	form	string	No

**CreateGuestPassResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
GuestPassId	form	int	No

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

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /club/guest-pass/create HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	XForwardedFor: String,
	ApiKey: String,
	UserId: 0,
	StoreId: 0,
	GuestPassTypeId: 0,
	Activated: False,
	Expires: 0001-01-01,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	GuestPassId: 0,
	Message: String
}