ClubReady Api

<back to all web services

GetGuestPassTypesRequest

The following routes are available for this service:
GET/club/guest-pass/typesGuest passes available at location.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetGuestPassTypesRequest extends GetGuestPassTypesRequestDto 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;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetGuestPassTypesRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetGuestPassTypesRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GetGuestPassTypesRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetGuestPassTypesRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetGuestPassTypesRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class GetGuestPassTypesRequestDto extends ApiDtoBase
    {
        
    }

    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 GetGuestPassTypesResponse extends GetGuestPassTypesResponseDto
    {
        public ArrayList<GuestPassTypeDto> GuestPassTypes = null;
        
        public ArrayList<GuestPassTypeDto> getGuestPassTypes() { return GuestPassTypes; }
        public GetGuestPassTypesResponse setGuestPassTypes(ArrayList<GuestPassTypeDto> value) { this.GuestPassTypes = value; return this; }
    }

    public static class GetGuestPassTypesResponseDto extends ApiResponseBase
    {
        public ArrayList<GuestPassTypeDto> GuestPassTypes = null;
        
        public ArrayList<GuestPassTypeDto> getGuestPassTypes() { return GuestPassTypes; }
        public GetGuestPassTypesResponseDto setGuestPassTypes(ArrayList<GuestPassTypeDto> value) { this.GuestPassTypes = 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 GuestPassTypeDto
    {
        public Integer GuestPassTypeId = null;
        public Integer ChainId = null;
        public Integer StoreId = null;
        public String PassName = null;
        public Integer DurationDays = null;
        public Boolean ExpirationEditable = null;
        public Integer MaxDurationDays = null;
        public Boolean AutoActivateWhenIssued = null;
        public Boolean IssueBarcodeWhenActivated = null;
        public String TagWhenActivated = null;
        public Integer MaxIssuedCount = null;
        public Boolean IsDeleted = null;
        public Integer InactiveCount = null;
        public Integer ActiveCount = null;
        public Integer ExpiredCount = null;
        public Integer TotalCount = null;
        
        public Integer getGuestPassTypeId() { return GuestPassTypeId; }
        public GuestPassTypeDto setGuestPassTypeId(Integer value) { this.GuestPassTypeId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GuestPassTypeDto setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GuestPassTypeDto setStoreId(Integer value) { this.StoreId = value; return this; }
        public String getPassName() { return PassName; }
        public GuestPassTypeDto setPassName(String value) { this.PassName = value; return this; }
        public Integer getDurationDays() { return DurationDays; }
        public GuestPassTypeDto setDurationDays(Integer value) { this.DurationDays = value; return this; }
        public Boolean isExpirationEditable() { return ExpirationEditable; }
        public GuestPassTypeDto setExpirationEditable(Boolean value) { this.ExpirationEditable = value; return this; }
        public Integer getMaxDurationDays() { return MaxDurationDays; }
        public GuestPassTypeDto setMaxDurationDays(Integer value) { this.MaxDurationDays = value; return this; }
        public Boolean isAutoActivateWhenIssued() { return AutoActivateWhenIssued; }
        public GuestPassTypeDto setAutoActivateWhenIssued(Boolean value) { this.AutoActivateWhenIssued = value; return this; }
        public Boolean getIssueBarcodeWhenActivated() { return IssueBarcodeWhenActivated; }
        public GuestPassTypeDto setIssueBarcodeWhenActivated(Boolean value) { this.IssueBarcodeWhenActivated = value; return this; }
        public String getTagWhenActivated() { return TagWhenActivated; }
        public GuestPassTypeDto setTagWhenActivated(String value) { this.TagWhenActivated = value; return this; }
        public Integer getMaxIssuedCount() { return MaxIssuedCount; }
        public GuestPassTypeDto setMaxIssuedCount(Integer value) { this.MaxIssuedCount = value; return this; }
        public Boolean getIsDeleted() { return IsDeleted; }
        public GuestPassTypeDto setIsDeleted(Boolean value) { this.IsDeleted = value; return this; }
        public Integer getInactiveCount() { return InactiveCount; }
        public GuestPassTypeDto setInactiveCount(Integer value) { this.InactiveCount = value; return this; }
        public Integer getActiveCount() { return ActiveCount; }
        public GuestPassTypeDto setActiveCount(Integer value) { this.ActiveCount = value; return this; }
        public Integer getExpiredCount() { return ExpiredCount; }
        public GuestPassTypeDto setExpiredCount(Integer value) { this.ExpiredCount = value; return this; }
        public Integer getTotalCount() { return TotalCount; }
        public GuestPassTypeDto setTotalCount(Integer value) { this.TotalCount = value; return this; }
    }

}

Java GetGuestPassTypesRequest 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/types HTTP/1.1 
Host: www.clubready.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"GuestPassTypes":[{"GuestPassTypeId":0,"ChainId":0,"StoreId":0,"PassName":"String","DurationDays":0,"ExpirationEditable":false,"MaxDurationDays":0,"AutoActivateWhenIssued":false,"IssueBarcodeWhenActivated":false,"TagWhenActivated":"String","MaxIssuedCount":0,"IsDeleted":false,"InactiveCount":0,"ActiveCount":0,"ExpiredCount":0,"TotalCount":0}],"Success":false,"Message":"String"}