ClubReady Api

AddUserWaiverRequest

The following routes are available for this service:
POST	/users/{UserId}/add-waiver	Add a waiver for a user.


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

export class AddUserWaiverRequest 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;

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

    /**
    * Form ID
    */
    // @ApiMember(DataType="integer", Description="Form ID", Name="FormId", ParameterType="query")
    public FormId?: number;

    /**
    * Base64 encoded PDF string
    */
    // @ApiMember(DataType="string", Description="Base64 encoded PDF string", IsRequired=true, Name="WaiverPdf", ParameterType="form")
    public WaiverPdf: string;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

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

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

TypeScript AddUserWaiverRequest 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 /users/{UserId}/add-waiver HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	StoreId: 0,
	UserId: 0,
	FormId: 0,
	WaiverPdf: String,
	RestrictedId: 0,
	RestrictedResourceType: Store
}

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

{
	Success: False,
	Message: String
}