ClubReady Api

<back to all web services

ActivateGuestPassRequest

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 ActivateGuestPassRequestDto extends ApiDtoBase
{
    public GuestPassId: number;
    public Expires?: string;

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

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

export class ActivateGuestPassRequest extends ActivateGuestPassRequestDto 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;

    /**
    * Guest pass to activate.
    */
    // @ApiMember(DataType="integer", Description="Guest pass to activate.", IsRequired=true, Name="GuestPassId", ParameterType="query")
    public GuestPassId: number;

    /**
    * 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 Expires?: string;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<ActivateGuestPassRequest>) { 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 ActivateGuestPassResponseDto extends ApiResponseBase
{

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

export class ActivateGuestPassResponse extends ActivateGuestPassResponseDto
{
    public Success: boolean;
    public Message: string;

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

TypeScript ActivateGuestPassRequest DTOs

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

{
	ApiKey: String,
	StoreId: 0,
	GuestPassId: 0,
	Expires: 0001-01-01,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}

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

{
	Success: False,
	Message: String
}