| GET | /users | Get a list of users |
|---|
namespace Richemont.Booster2.PublicApi.Security.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type GetUserResponse() =
///<summary>
///Unique Identifier of a User
///</summary>
[<ApiMember(Description="Unique Identifier of a User", IsRequired=true)>]
member val userId:Guid = new Guid() with get,set
///<summary>
///User's Email address
///</summary>
[<ApiMember(Description="User's Email address", IsRequired=true)>]
member val emailAddress:String = null with get,set
///<summary>
///First Name
///</summary>
[<ApiMember(Description="First Name", IsRequired=true)>]
member val firstName:String = null with get,set
///<summary>
///Last Name
///</summary>
[<ApiMember(Description="Last Name", IsRequired=true)>]
member val lastName:String = null with get,set
///<summary>
///User's Password Expiration Date
///</summary>
[<ApiMember(Description="User's Password Expiration Date")>]
member val passwordExpirationDate:String = null with get,set
///<summary>
///If the User must change the password
///</summary>
[<ApiMember(Description="If the User must change the password", IsRequired=true)>]
member val passwordMustBeChanged:Boolean = new Boolean() with get,set
///<summary>
///User Type of the User
///</summary>
[<ApiMember(Description="User Type of the User", IsRequired=true)>]
member val userType:String = null with get,set
///<summary>
///Culture ID of the User
///</summary>
[<ApiMember(Description="Culture ID of the User", IsRequired=true)>]
member val culture:String = null with get,set
///<summary>
///If the User account is locked
///</summary>
[<ApiMember(Description="If the User account is locked", IsRequired=true)>]
member val accountLocked:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type GetUsersResponse() =
///<summary>
///Index of the result set returnedr
///</summary>
[<ApiMember(Description="Index of the result set returnedr", IsRequired=true)>]
member val page:Int32 = new Int32() with get,set
///<summary>
///Size of the result set returned
///</summary>
[<ApiMember(Description="Size of the result set returned", IsRequired=true)>]
member val items:Int32 = new Int32() with get,set
///<summary>
///Total amount of pages / result sets
///</summary>
[<ApiMember(Description="Total amount of pages / result sets", IsRequired=true)>]
member val totalPages:Int32 = new Int32() with get,set
///<summary>
///Total amount of results
///</summary>
[<ApiMember(Description="Total amount of results", IsRequired=true)>]
member val totalResults:Int32 = new Int32() with get,set
///<summary>
///List of Users
///</summary>
[<ApiMember(Description="List of Users", IsRequired=true)>]
member val elements:IEnumerable<GetUserResponse> = null with get,set
[<AllowNullLiteral>]
type GetUsers() =
///<summary>
///Index of the result set returned
///</summary>
[<ApiMember(Description="Index of the result set returned", IsRequired=true)>]
member val page:Int32 = new Int32() with get,set
///<summary>
///Size of the result set returned
///</summary>
[<ApiMember(Description="Size of the result set returned", IsRequired=true)>]
member val items:Int32 = new Int32() with get,set
///<summary>
///Omit precise record count - save on performance
///</summary>
[<ApiMember(Description="Omit precise record count - save on performance")>]
member val noCount:Boolean = new Boolean() with get,set
///<summary>
///Sorting expression
///</summary>
[<ApiMember(Description="Sorting expression")>]
member val sortBy:String = null with get,set
///<summary>
///Email address
///</summary>
[<ApiMember(Description="Email address")>]
member val email:String = null with get,set
///<summary>
///Also retreive users with locked account
///</summary>
[<ApiMember(Description="Also retreive users with locked account")>]
member val includeLockedAccounts:Nullable<Boolean> = new Nullable<Boolean>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}