ClubReady Api

<back to all web services

CreateGuestPassRequest

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CreateGuestPassRequest extends CreateGuestPassRequestDto 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;

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

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

        /**
        * Guest pass type to create.
        */
        @ApiMember(DataType="integer", Description="Guest pass type to create.", IsRequired=true, Name="GuestPassTypeId", ParameterType="query")
        public Integer GuestPassTypeId = null;

        /**
        * Activate this Guest Pass immediately? (True or False)
        */
        @ApiMember(DataType="bool", Description="Activate this Guest Pass immediately? (True or False)", IsRequired=true, Name="Activated", ParameterType="query")
        public Boolean Activated = null;

        /**
        * When will this pass expire? (leave blank for never)
        */
        @ApiMember(DataType="datetime", Description="When will this pass expire? (leave blank for never)", Name="Expires", ParameterType="query")
        public Date Expires = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public CreateGuestPassRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getUserId() { return UserId; }
        public CreateGuestPassRequest setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public CreateGuestPassRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getGuestPassTypeId() { return GuestPassTypeId; }
        public CreateGuestPassRequest setGuestPassTypeId(Integer value) { this.GuestPassTypeId = value; return this; }
        public Boolean isActivated() { return Activated; }
        public CreateGuestPassRequest setActivated(Boolean value) { this.Activated = value; return this; }
        public Date getExpires() { return Expires; }
        public CreateGuestPassRequest setExpires(Date value) { this.Expires = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public CreateGuestPassRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public CreateGuestPassRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class CreateGuestPassRequestDto extends ApiDtoBase
    {
        public Integer UserId = null;
        public Integer GuestPassTypeId = null;
        public Boolean Activated = null;
        public Date Expires = null;
        
        public Integer getUserId() { return UserId; }
        public CreateGuestPassRequestDto setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getGuestPassTypeId() { return GuestPassTypeId; }
        public CreateGuestPassRequestDto setGuestPassTypeId(Integer value) { this.GuestPassTypeId = value; return this; }
        public Boolean isActivated() { return Activated; }
        public CreateGuestPassRequestDto setActivated(Boolean value) { this.Activated = value; return this; }
        public Date getExpires() { return Expires; }
        public CreateGuestPassRequestDto setExpires(Date value) { this.Expires = 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 CreateGuestPassResponse extends CreateGuestPassResponseDto
    {
        public Boolean Success = null;
        public Integer GuestPassId = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public CreateGuestPassResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public Integer getGuestPassId() { return GuestPassId; }
        public CreateGuestPassResponse setGuestPassId(Integer value) { this.GuestPassId = value; return this; }
        public String getMessage() { return Message; }
        public CreateGuestPassResponse setMessage(String value) { this.Message = value; return this; }
    }

    public static class CreateGuestPassResponseDto extends ApiResponseBase
    {
        public Integer GuestPassId = null;
        
        public Integer getGuestPassId() { return GuestPassId; }
        public CreateGuestPassResponseDto setGuestPassId(Integer value) { this.GuestPassId = 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; }
    }

}

Java CreateGuestPassRequest DTOs

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

{
	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
}