| GET | /users | Get a list of users |
|---|
export class GetUserResponse
{
/** @description Unique Identifier of a User */
// @ApiMember(Description="Unique Identifier of a User", IsRequired=true)
public userId: string;
/** @description User's Email address */
// @ApiMember(Description="User's Email address", IsRequired=true)
public emailAddress: string;
/** @description First Name */
// @ApiMember(Description="First Name", IsRequired=true)
public firstName: string;
/** @description Last Name */
// @ApiMember(Description="Last Name", IsRequired=true)
public lastName: string;
/** @description User's Password Expiration Date */
// @ApiMember(Description="User's Password Expiration Date")
public passwordExpirationDate: string;
/** @description If the User must change the password */
// @ApiMember(Description="If the User must change the password", IsRequired=true)
public passwordMustBeChanged: boolean;
/** @description User Type of the User */
// @ApiMember(Description="User Type of the User", IsRequired=true)
public userType: string;
/** @description Culture ID of the User */
// @ApiMember(Description="Culture ID of the User", IsRequired=true)
public culture: string;
/** @description If the User account is locked */
// @ApiMember(Description="If the User account is locked", IsRequired=true)
public accountLocked: boolean;
public constructor(init?: Partial<GetUserResponse>) { (Object as any).assign(this, init); }
}
export class GetUsersResponse
{
/** @description Index of the result set returnedr */
// @ApiMember(Description="Index of the result set returnedr", IsRequired=true)
public page: number;
/** @description Size of the result set returned */
// @ApiMember(Description="Size of the result set returned", IsRequired=true)
public items: number;
/** @description Total amount of pages / result sets */
// @ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
public totalPages: number;
/** @description Total amount of results */
// @ApiMember(Description="Total amount of results", IsRequired=true)
public totalResults: number;
/** @description List of Users */
// @ApiMember(Description="List of Users", IsRequired=true)
public elements: GetUserResponse[];
public constructor(init?: Partial<GetUsersResponse>) { (Object as any).assign(this, init); }
}
export class GetUsers implements IPagedRequest
{
/** @description Index of the result set returned */
// @ApiMember(Description="Index of the result set returned", IsRequired=true)
public page: number;
/** @description Size of the result set returned */
// @ApiMember(Description="Size of the result set returned", IsRequired=true)
public items: number;
/** @description Omit precise record count - save on performance */
// @ApiMember(Description="Omit precise record count - save on performance")
public noCount: boolean;
/** @description Sorting expression */
// @ApiMember(Description="Sorting expression")
public sortBy: string;
/** @description Email address */
// @ApiMember(Description="Email address")
public email: string;
/** @description Also retreive users with locked account */
// @ApiMember(Description="Also retreive users with locked account")
public includeLockedAccounts?: boolean;
public constructor(init?: Partial<GetUsers>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users HTTP/1.1 Host: dev-api-booster.richemont.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}