ClubReady Api

<back to all web services

GetGuestPassesRequest

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 GetGuestPassRequestDto extends ApiDtoBase
{
    public UserId: number;

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

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

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

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

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

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetGuestPassesRequest>) { 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 GuestPassSimple
{
    public GuestPassId: number;
    public GuestPassTypeId: number;
    public StoreId: number;
    public ActivatedOn?: string;
    public Expires?: string;

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

export class GetGuestPassResponseDto extends ApiResponseBase
{
    public GuestPasses: GuestPassSimple[];

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

export class GetGuestPassesResponse extends GetGuestPassResponseDto
{
    public Success: boolean;
    public Message: string;
    public GuestPasses: GuestPassSimple[];

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

TypeScript GetGuestPassesRequest DTOs

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

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	GuestPasses: 
	[
		{
			GuestPassId: 0,
			GuestPassTypeId: 0,
			StoreId: 0,
			ActivatedOn: 0001-01-01,
			Expires: 0001-01-01
		}
	]
}