ClubReady Api

CreateGuestPassRequest

The following routes are available for this service:
POST	/club/guest-pass/create	Create a guest pass for a user.


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 CreateGuestPassRequestDto extends ApiDtoBase
{
    public UserId: number;
    public GuestPassTypeId: number;
    public Activated: boolean;
    public Expires?: string;

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

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

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

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

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

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

    /**
    * 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 Activated: boolean;

    /**
    * 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<CreateGuestPassRequest>) { 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 CreateGuestPassResponseDto extends ApiResponseBase
{
    public GuestPassId: number;

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

export class CreateGuestPassResponse extends CreateGuestPassResponseDto
{
    public Success: boolean;
    public GuestPassId: number;
    public Message: string;

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

TypeScript CreateGuestPassRequest 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.

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
}