GET | /users/date-added | List of users added in a certain date range. |
---|
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 UserListDateAddedRequestDto extends ApiDtoBase
{
public FromDate: string;
public ToDate: string;
public constructor(init?: Partial<UserListDateAddedRequestDto>) { super(init); (Object as any).assign(this, init); }
}
export enum RestrictedResourceType
{
Store = 'Store',
Chain = 'Chain',
User = 'User',
Undefined = 'Undefined',
}
export class UserListDateAddedRequest extends UserListDateAddedRequestDto 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;
/**
* Chain ID
*/
// @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
public ChainId?: number;
/**
* Store ID
*/
// @ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")
public StoreId?: number;
/**
* UTC Format
*/
// @ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")
public FromDate: string;
/**
* Max 24 Hours (UTC Format)
*/
// @ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")
public ToDate: string;
public RestrictedId?: number;
public RestrictedResourceType: RestrictedResourceType;
public constructor(init?: Partial<UserListDateAddedRequest>) { super(init); (Object as any).assign(this, init); }
}
export class ClubClient
{
public UserId: number;
public Username: string;
public FirstName: string;
public LastName: string;
public StoreId?: number;
public DateAdded?: string;
public ReferredBy?: number;
public AddedBy?: number;
public ReferralTypeId?: number;
public ReferralTypeName: string;
public constructor(init?: Partial<ClubClient>) { (Object as any).assign(this, init); }
}
export class UserListDateAddedResponseDto
{
public Users: ClubClient[];
public constructor(init?: Partial<UserListDateAddedResponseDto>) { (Object as any).assign(this, init); }
}
export class UserListDateAddedResponse extends UserListDateAddedResponseDto
{
public Users: ClubClient[];
public constructor(init?: Partial<UserListDateAddedResponse>) { super(init); (Object as any).assign(this, init); }
}
TypeScript UserListDateAddedRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/date-added HTTP/1.1 Host: www.clubready.com Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Users":[{"UserId":0,"Username":"String","FirstName":"String","LastName":"String","StoreId":0,"DateAdded":"0001-01-01T00:00:00.0000000","ReferredBy":0,"AddedBy":0,"ReferralTypeId":0,"ReferralTypeName":"String"}]}