Richemont.Booster2.PublicApi

GetUsers

The following routes are available for this service:
GET	/users	Get a list of users

**GetUsers** Parameters:
Name	Parameter	Data Type	Required	Description
page	query	int	Yes	Index of the result set returned
items	query	int	Yes	Size of the result set returned
noCount	query	bool	No	Omit precise record count - save on performance
sortBy	query	string	No	Sorting expression
email	query	string	No	Email address
includeLockedAccounts	query	bool?	No	Also retreive users with locked account

**GetUsersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
page	form	int	Yes	Index of the result set returnedr
items	form	int	Yes	Size of the result set returned
totalPages	form	int	Yes	Total amount of pages / result sets
totalResults	form	int	Yes	Total amount of results
elements	form	IEnumerable<GetUserResponse>	Yes	List of Users

**GetUserResponse** Parameters:
Name	Parameter	Data Type	Required	Description
userId	form	Guid	Yes	Unique Identifier of a User
emailAddress	form	string	Yes	User's Email address
firstName	form	string	Yes	First Name
lastName	form	string	Yes	Last Name
passwordExpirationDate	form	string	No	User's Password Expiration Date
passwordMustBeChanged	form	bool	Yes	If the User must change the password
userType	form	string	Yes	User Type of the User
culture	form	string	Yes	Culture ID of the User
accountLocked	form	bool	Yes	If the User account is locked

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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