Richemont.Booster2.PublicApi

<back to all web services

GetUsers

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); }
}

TypeScript GetUsers DTOs

GET /users HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel">
  <elements i:nil="true" />
  <items>0</items>
  <page>0</page>
  <totalPages>0</totalPages>
  <totalResults>0</totalResults>
</GetUsersResponse>