ClubReady Api

<back to all web services

CreateGuestPassRequest

The following routes are available for this service:
POST/club/guest-pass/createCreate a guest pass for a user.
CreateGuestPassRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
UserIdquerystringYesUser ID
StoreIdqueryintegerYesStore ID
GuestPassTypeIdqueryintegerYesGuest pass type to create.
ActivatedqueryboolYesActivate this Guest Pass immediately? (True or False)
ExpiresquerydatetimeNoWhen will this pass expire? (leave blank for never)
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
CreateGuestPassRequestDto Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
GuestPassTypeIdformintNo
ActivatedformboolNo
ExpiresformDateTime?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
CreateGuestPassResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
GuestPassIdformintNo
MessageformstringNo
CreateGuestPassResponseDto Parameters:
NameParameterData TypeRequiredDescription
GuestPassIdformintNo
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

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

HTTP + JSON

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: clubready.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"String","UserId":0,"StoreId":0,"GuestPassTypeId":0,"Activated":false,"Expires":"0001-01-01T00:00:00.0000000","RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Success":false,"GuestPassId":0,"Message":"String"}