ClubReady Api

<back to all web services

GetGuestPassesRequest

The following routes are available for this service:
GET/club/guest-pass/getGet a user's guest pass(es).
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetGuestPassesRequest extends GetGuestPassRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

        /**
        * Store ID
        */
        @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * User ID
        */
        @ApiMember(DataType="integer", Description="User ID", IsRequired=true, Name="UserId", ParameterType="query")
        public Integer UserId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetGuestPassesRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetGuestPassesRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getUserId() { return UserId; }
        public GetGuestPassesRequest setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetGuestPassesRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetGuestPassesRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class GetGuestPassRequestDto extends ApiDtoBase
    {
        public Integer UserId = null;
        
        public Integer getUserId() { return UserId; }
        public GetGuestPassRequestDto setUserId(Integer value) { this.UserId = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static class GetGuestPassesResponse extends GetGuestPassResponseDto
    {
        public Boolean Success = null;
        public String Message = null;
        public ArrayList<GuestPassSimple> GuestPasses = null;
        
        public Boolean isSuccess() { return Success; }
        public GetGuestPassesResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public GetGuestPassesResponse setMessage(String value) { this.Message = value; return this; }
        public ArrayList<GuestPassSimple> getGuestPasses() { return GuestPasses; }
        public GetGuestPassesResponse setGuestPasses(ArrayList<GuestPassSimple> value) { this.GuestPasses = value; return this; }
    }

    public static class GetGuestPassResponseDto extends ApiResponseBase
    {
        public ArrayList<GuestPassSimple> GuestPasses = null;
        
        public ArrayList<GuestPassSimple> getGuestPasses() { return GuestPasses; }
        public GetGuestPassResponseDto setGuestPasses(ArrayList<GuestPassSimple> value) { this.GuestPasses = value; return this; }
    }

    public static class ApiResponseBase
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public ApiResponseBase setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ApiResponseBase setMessage(String value) { this.Message = value; return this; }
    }

    public static class GuestPassSimple
    {
        public Integer GuestPassId = null;
        public Integer GuestPassTypeId = null;
        public Integer StoreId = null;
        public Date ActivatedOn = null;
        public Date Expires = null;
        
        public Integer getGuestPassId() { return GuestPassId; }
        public GuestPassSimple setGuestPassId(Integer value) { this.GuestPassId = value; return this; }
        public Integer getGuestPassTypeId() { return GuestPassTypeId; }
        public GuestPassSimple setGuestPassTypeId(Integer value) { this.GuestPassTypeId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GuestPassSimple setStoreId(Integer value) { this.StoreId = value; return this; }
        public Date getActivatedOn() { return ActivatedOn; }
        public GuestPassSimple setActivatedOn(Date value) { this.ActivatedOn = value; return this; }
        public Date getExpires() { return Expires; }
        public GuestPassSimple setExpires(Date value) { this.Expires = value; return this; }
    }

}

Java GetGuestPassesRequest DTOs

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.

GET /club/guest-pass/get HTTP/1.1 
Host: clubready.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Success":false,"Message":"String","GuestPasses":[{"GuestPassId":0,"GuestPassTypeId":0,"StoreId":0,"ActivatedOn":"0001-01-01T00:00:00.0000000","Expires":"0001-01-01T00:00:00.0000000"}]}