ClubReady Api

<back to all web services

UserVisitHistoryRequest

Gets user check-in history based on a date range. Max 31 days.

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 UserVisitHistoryRequestDto extends ApiDtoBase
{
    public UserId: number;
    public FromDate: string;
    public ToDate: string;

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

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

/**
* Gets user check-in history based on a date range. Max 31 days.
*/
// @Api(Description="Gets user check-in history based on a date range. Max 31 days.")
export class UserVisitHistoryRequest extends UserVisitHistoryRequestDto 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;

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

    /**
    * StoreId OR ChainId is required
    */
    // @ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")
    public StoreId?: number;

    /**
    * StoreId OR ChainId is required
    */
    // @ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * (Format:YYYY-MM-DD)
    */
    // @ApiMember(DataType="date", Description="(Format:YYYY-MM-DD)", IsRequired=true, Name="FromDate", ParameterType="query")
    public FromDate: string;

    /**
    * Max 31 Days (Format:YYYY-MM-DD)
    */
    // @ApiMember(DataType="date", Description="Max 31 Days (Format:YYYY-MM-DD)", IsRequired=true, Name="ToDate", ParameterType="query")
    public ToDate: string;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

TypeScript UserVisitHistoryRequest DTOs

GET /users/{UserId}/visit-history HTTP/1.1 
Host: clubready.com 
Accept: text/csv