ClubReady Api

<back to all web services

UsersListRequest

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 UsersListRequestDto extends ApiDtoBase
{
    public Segment: string;
    public ActivityDate: string;
    public ActivityOperator: string;

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

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

export class UsersListRequest extends UsersListRequestDto 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;

    /**
    * 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="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * Date to use for filter
    */
    // @ApiMember(DataType="Date", Description="Date to use for filter", IsRequired=true, Name="ActivityDate", ParameterType="query")
    public ActivityDate: string;

    /**
    * The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.
    */
    // @ApiMember(DataType="String", Description="The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.", Name="ActivityOperator", ParameterType="query")
    public ActivityOperator: string;

    /**
    * Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue
    */
    // @ApiMember(DataType="string", Description="Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue", Name="Segment", ParameterType="query")
    public Segment: string;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;
    /**
    * Version 2 adds email and mobile phone to output
    */
    // @ApiMember(DataType="string", Description="Version 2 adds email and mobile phone to output", Name="Version", ParameterType="query")
    public Version?: number;

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

TypeScript UsersListRequest DTOs

GET /users HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml