ClubReady Api

<back to all web services

SearchUsersRequest

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 SearchUsersRequestDto extends ApiDtoBase
{
    public Barcode: string;
    public FirstName: string;
    public LastName: string;
    public Email: string;
    public Phone: string;
    public UserType?: number;
    public Page?: number;

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

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

export class SearchUsersRequest extends SearchUsersRequestDto 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;

    /**
    * Filter by First Name
    */
    // @ApiMember(DataType="string", Description="Filter by First Name", Name="FirstName", ParameterType="query")
    public FirstName: string;

    /**
    * Filter by Last Name
    */
    // @ApiMember(DataType="string", Description="Filter by Last Name", Name="LastName", ParameterType="query")
    public LastName: string;

    /**
    * StoreId OR ChainId is required
    */
    // @ApiMember(DataType="integer", 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;

    /**
    * Filter by barcode
    */
    // @ApiMember(DataType="string", Description="Filter by barcode", Name="Barcode", ParameterType="query")
    public Barcode: string;

    /**
    * Filter by Email Address
    */
    // @ApiMember(DataType="string", Description="Filter by Email Address", Name="Email", ParameterType="query")
    public Email: string;

    /**
    * Filter by Phone Number
    */
    // @ApiMember(DataType="string", Description="Filter by Phone Number", Name="Phone", ParameterType="query")
    public Phone: string;

    /**
    * Filter by ClubReady User Type
    */
    // @ApiMember(DataType="integer", Description="Filter by ClubReady User Type", Name="UserType", ParameterType="query")
    public UserType?: number;

    /**
    * Page of users to retrieve. Pulls back 100 users per page.
    */
    // @ApiMember(DataType="integer", Description="Page of users to retrieve. Pulls back 100 users per page.", Name="Page", ParameterType="query")
    public Page?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

TypeScript SearchUsersRequest DTOs

GET /users/find HTTP/1.1 
Host: clubready.com 
Accept: text/csv