| POST | /users/checkin | Check User Into Club |
|---|
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 DoCheckInRequestDto extends ApiDtoBase
{
public Barcode: string;
public UserId?: number;
public UtcTimeStamp: string;
public constructor(init?: Partial<DoCheckInRequestDto>) { super(init); (Object as any).assign(this, init); }
}
export enum RestrictedResourceType
{
Store = 'Store',
Chain = 'Chain',
User = 'User',
Undefined = 'Undefined',
}
/**
* Check a user into a club
*/
// @Api(Description="Check a user into a club")
export class DoCheckInRequest extends DoCheckInRequestDto 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 barcode
*/
// @ApiMember(DataType="string", Description="User barcode", IsRequired=true, Name="Barcode", ParameterType="query")
public Barcode: string;
/**
* ClubReady StoreId required
*/
// @ApiMember(DataType="integer", Description="ClubReady StoreId required", IsRequired=true, Name="StoreId", ParameterType="query")
public StoreId: number;
/**
* UserId to check into club
*/
// @ApiMember(DataType="integer", Description="UserId to check into club", Name="UserId", ParameterType="query")
public UserId?: number;
public RestrictedId?: number;
public RestrictedResourceType: RestrictedResourceType;
public constructor(init?: Partial<DoCheckInRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript DoCheckInRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/checkin HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
Barcode: String,
StoreId: 0,
UserId: 0,
RestrictedId: 0,
RestrictedResourceType: Store,
UtcTimeStamp: 0001-01-01,
ChainId: 0
}