| GET | /users | Get a list of users |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetUsers : IPagedRequest
{
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned", IsRequired=true)
var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
var items:Int? = null
/**
* Omit precise record count - save on performance
*/
@ApiMember(Description="Omit precise record count - save on performance")
var noCount:Boolean? = null
/**
* Sorting expression
*/
@ApiMember(Description="Sorting expression")
var sortBy:String? = null
/**
* Email address
*/
@ApiMember(Description="Email address")
var email:String? = null
/**
* Also retreive users with locked account
*/
@ApiMember(Description="Also retreive users with locked account")
var includeLockedAccounts:Boolean? = null
}
open class GetUsersResponse
{
/**
* Index of the result set returnedr
*/
@ApiMember(Description="Index of the result set returnedr", IsRequired=true)
var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
var items:Int? = null
/**
* Total amount of pages / result sets
*/
@ApiMember(Description="Total amount of pages / result sets", IsRequired=true)
var totalPages:Int? = null
/**
* Total amount of results
*/
@ApiMember(Description="Total amount of results", IsRequired=true)
var totalResults:Int? = null
/**
* List of Users
*/
@ApiMember(Description="List of Users", IsRequired=true)
var elements:ArrayList<GetUserResponse> = ArrayList<GetUserResponse>()
}
open class GetUserResponse
{
/**
* Unique Identifier of a User
*/
@ApiMember(Description="Unique Identifier of a User", IsRequired=true)
var userId:UUID? = null
/**
* User's Email address
*/
@ApiMember(Description="User's Email address", IsRequired=true)
var emailAddress:String? = null
/**
* First Name
*/
@ApiMember(Description="First Name", IsRequired=true)
var firstName:String? = null
/**
* Last Name
*/
@ApiMember(Description="Last Name", IsRequired=true)
var lastName:String? = null
/**
* User's Password Expiration Date
*/
@ApiMember(Description="User's Password Expiration Date")
var passwordExpirationDate:String? = null
/**
* If the User must change the password
*/
@ApiMember(Description="If the User must change the password", IsRequired=true)
var passwordMustBeChanged:Boolean? = null
/**
* User Type of the User
*/
@ApiMember(Description="User Type of the User", IsRequired=true)
var userType:String? = null
/**
* Culture ID of the User
*/
@ApiMember(Description="Culture ID of the User", IsRequired=true)
var culture:String? = null
/**
* If the User account is locked
*/
@ApiMember(Description="If the User account is locked", IsRequired=true)
var accountLocked:Boolean? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
page: 0,
items: 0,
totalPages: 0,
totalResults: 0
}