Richemont.Booster2.PublicApi

<back to all web services

GetUsers

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetUsers implements IPagedRequest
    {
        /**
        * Index of the result set returned
        */
        @ApiMember(Description="Index of the result set returned", IsRequired=true)
        public Integer page = null;

        /**
        * Size of the result set returned
        */
        @ApiMember(Description="Size of the result set returned", IsRequired=true)
        public Integer items = null;

        /**
        * Omit precise record count - save on performance
        */
        @ApiMember(Description="Omit precise record count - save on performance")
        public Boolean noCount = null;

        /**
        * Sorting expression
        */
        @ApiMember(Description="Sorting expression")
        public String sortBy = null;

        /**
        * Email address
        */
        @ApiMember(Description="Email address")
        public String email = null;

        /**
        * Also retreive users with locked account
        */
        @ApiMember(Description="Also retreive users with locked account")
        public Boolean includeLockedAccounts = null;
        
        public Integer getPage() { return page; }
        public GetUsers setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetUsers setItems(Integer value) { this.items = value; return this; }
        public Boolean isNoCount() { return noCount; }
        public GetUsers setNoCount(Boolean value) { this.noCount = value; return this; }
        public String getSortBy() { return sortBy; }
        public GetUsers setSortBy(String value) { this.sortBy = value; return this; }
        public String getEmail() { return email; }
        public GetUsers setEmail(String value) { this.email = value; return this; }
        public Boolean isIncludeLockedAccounts() { return includeLockedAccounts; }
        public GetUsers setIncludeLockedAccounts(Boolean value) { this.includeLockedAccounts = value; return this; }
    }

    public static class GetUsersResponse
    {
        /**
        * Index of the result set returnedr
        */
        @ApiMember(Description="Index of the result set returnedr", IsRequired=true)
        public Integer page = null;

        /**
        * Size of the result set returned
        */
        @ApiMember(Description="Size of the result set returned", IsRequired=true)
        public Integer items = null;

        /**
        * Total amount of pages / result sets
        */
        @ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
        public Integer totalPages = null;

        /**
        * Total amount of results
        */
        @ApiMember(Description="Total amount of results", IsRequired=true)
        public Integer totalResults = null;

        /**
        * List of Users
        */
        @ApiMember(Description="List of Users", IsRequired=true)
        public ArrayList<GetUserResponse> elements = null;
        
        public Integer getPage() { return page; }
        public GetUsersResponse setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetUsersResponse setItems(Integer value) { this.items = value; return this; }
        public Integer getTotalPages() { return totalPages; }
        public GetUsersResponse setTotalPages(Integer value) { this.totalPages = value; return this; }
        public Integer getTotalResults() { return totalResults; }
        public GetUsersResponse setTotalResults(Integer value) { this.totalResults = value; return this; }
        public ArrayList<GetUserResponse> getElements() { return elements; }
        public GetUsersResponse setElements(ArrayList<GetUserResponse> value) { this.elements = value; return this; }
    }

    public static class GetUserResponse
    {
        /**
        * Unique Identifier of a User
        */
        @ApiMember(Description="Unique Identifier of a User", IsRequired=true)
        public UUID userId = null;

        /**
        * User's Email address
        */
        @ApiMember(Description="User's Email address", IsRequired=true)
        public String emailAddress = null;

        /**
        * First Name
        */
        @ApiMember(Description="First Name", IsRequired=true)
        public String firstName = null;

        /**
        * Last Name
        */
        @ApiMember(Description="Last Name", IsRequired=true)
        public String lastName = null;

        /**
        * User's Password Expiration Date
        */
        @ApiMember(Description="User's Password Expiration Date")
        public String passwordExpirationDate = null;

        /**
        * If the User must change the password
        */
        @ApiMember(Description="If the User must change the password", IsRequired=true)
        public Boolean passwordMustBeChanged = null;

        /**
        * User Type of the User
        */
        @ApiMember(Description="User Type of the User", IsRequired=true)
        public String userType = null;

        /**
        * Culture ID of the User
        */
        @ApiMember(Description="Culture ID of the User", IsRequired=true)
        public String culture = null;

        /**
        * If the User account is locked
        */
        @ApiMember(Description="If the User account is locked", IsRequired=true)
        public Boolean accountLocked = null;
        
        public UUID getUserId() { return userId; }
        public GetUserResponse setUserId(UUID value) { this.userId = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public GetUserResponse setEmailAddress(String value) { this.emailAddress = value; return this; }
        public String getFirstName() { return firstName; }
        public GetUserResponse setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public GetUserResponse setLastName(String value) { this.lastName = value; return this; }
        public String getPasswordExpirationDate() { return passwordExpirationDate; }
        public GetUserResponse setPasswordExpirationDate(String value) { this.passwordExpirationDate = value; return this; }
        public Boolean isPasswordMustBeChanged() { return passwordMustBeChanged; }
        public GetUserResponse setPasswordMustBeChanged(Boolean value) { this.passwordMustBeChanged = value; return this; }
        public String getUserType() { return userType; }
        public GetUserResponse setUserType(String value) { this.userType = value; return this; }
        public String getCulture() { return culture; }
        public GetUserResponse setCulture(String value) { this.culture = value; return this; }
        public Boolean isAccountLocked() { return accountLocked; }
        public GetUserResponse setAccountLocked(Boolean value) { this.accountLocked = value; return this; }
    }

}

Java 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>