ClubReady Api

<back to all web services

ActivateGuestPassRequest

The following routes are available for this service:
POST/club/guest-pass/activateActivate a guest pass.
ActivateGuestPassRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesStore ID
GuestPassIdqueryintegerYesGuest pass to activate.
ExpiresquerydatetimeNoWhen will this pass expire? (leave blank for never)
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
ActivateGuestPassRequestDto Parameters:
NameParameterData TypeRequiredDescription
GuestPassIdformintNo
ExpiresformDateTime?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
ActivateGuestPassResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

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/activate HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	StoreId: 0,
	GuestPassId: 0,
	Expires: 0001-01-01,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String
}