ClubReady Api

GetGuestPassTypesRequest

The following routes are available for this service:
GET	/club/guest-pass/types	Guest passes available at location.


export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class GetGuestPassTypesRequestDto extends ApiDtoBase
{

    public constructor(init?: Partial<GetGuestPassTypesRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export 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 ApiKey: string;

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

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

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetGuestPassTypesRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ApiResponseBase
{
    public Success: boolean;
    public Message: string;

    public constructor(init?: Partial<ApiResponseBase>) { (Object as any).assign(this, init); }
}

export class GuestPassTypeDto
{
    public GuestPassTypeId: number;
    public ChainId?: number;
    public StoreId?: number;
    public PassName: string;
    public DurationDays: number;
    public ExpirationEditable: boolean;
    public MaxDurationDays: number;
    public AutoActivateWhenIssued: boolean;
    public IssueBarcodeWhenActivated: boolean;
    public TagWhenActivated: string;
    public MaxIssuedCount: number;
    public IsDeleted: boolean;
    public InactiveCount: number;
    public ActiveCount: number;
    public ExpiredCount: number;
    public TotalCount: number;

    public constructor(init?: Partial<GuestPassTypeDto>) { (Object as any).assign(this, init); }
}

export class GetGuestPassTypesResponseDto extends ApiResponseBase
{
    public GuestPassTypes: GuestPassTypeDto[];

    public constructor(init?: Partial<GetGuestPassTypesResponseDto>) { super(init); (Object as any).assign(this, init); }
}

export class GetGuestPassTypesResponse extends GetGuestPassTypesResponseDto
{
    public GuestPassTypes: GuestPassTypeDto[];

    public constructor(init?: Partial<GetGuestPassTypesResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetGuestPassTypesRequest DTOs

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.

GET /club/guest-pass/types HTTP/1.1 
Host: clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
}