Richemont.Booster2.PublicApi

GetUsers

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Security.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.Security.ServiceModel

        Public Partial Class GetUserResponse
            '''<Summary>
            '''Unique Identifier of a User
            '''</Summary>
            <ApiMember(Description:="Unique Identifier of a User", IsRequired:=true)>
            Public Overridable Property userId As Guid

            '''<Summary>
            '''User's Email address
            '''</Summary>
            <ApiMember(Description:="User's Email address", IsRequired:=true)>
            Public Overridable Property emailAddress As String

            '''<Summary>
            '''First Name
            '''</Summary>
            <ApiMember(Description:="First Name", IsRequired:=true)>
            Public Overridable Property firstName As String

            '''<Summary>
            '''Last Name
            '''</Summary>
            <ApiMember(Description:="Last Name", IsRequired:=true)>
            Public Overridable Property lastName As String

            '''<Summary>
            '''User's Password Expiration Date
            '''</Summary>
            <ApiMember(Description:="User's Password Expiration Date")>
            Public Overridable Property passwordExpirationDate As String

            '''<Summary>
            '''If the User must change the password
            '''</Summary>
            <ApiMember(Description:="If the User must change the password", IsRequired:=true)>
            Public Overridable Property passwordMustBeChanged As Boolean

            '''<Summary>
            '''User Type of the User
            '''</Summary>
            <ApiMember(Description:="User Type of the User", IsRequired:=true)>
            Public Overridable Property userType As String

            '''<Summary>
            '''Culture ID of the User
            '''</Summary>
            <ApiMember(Description:="Culture ID of the User", IsRequired:=true)>
            Public Overridable Property culture As String

            '''<Summary>
            '''If the User account is locked
            '''</Summary>
            <ApiMember(Description:="If the User account is locked", IsRequired:=true)>
            Public Overridable Property accountLocked As Boolean
        End Class

        Public Partial Class GetUsers
            Implements IPagedRequest
            '''<Summary>
            '''Index of the result set returned
            '''</Summary>
            <ApiMember(Description:="Index of the result set returned", IsRequired:=true)>
            Public Overridable Property page As Integer

            '''<Summary>
            '''Size of the result set returned
            '''</Summary>
            <ApiMember(Description:="Size of the result set returned", IsRequired:=true)>
            Public Overridable Property items As Integer

            '''<Summary>
            '''Omit precise record count - save on performance
            '''</Summary>
            <ApiMember(Description:="Omit precise record count - save on performance")>
            Public Overridable Property noCount As Boolean

            '''<Summary>
            '''Sorting expression
            '''</Summary>
            <ApiMember(Description:="Sorting expression")>
            Public Overridable Property sortBy As String

            '''<Summary>
            '''Email address
            '''</Summary>
            <ApiMember(Description:="Email address")>
            Public Overridable Property email As String

            '''<Summary>
            '''Also retreive users with locked account
            '''</Summary>
            <ApiMember(Description:="Also retreive users with locked account")>
            Public Overridable Property includeLockedAccounts As Nullable(Of Boolean)
        End Class

        Public Partial Class GetUsersResponse
            '''<Summary>
            '''Index of the result set returnedr
            '''</Summary>
            <ApiMember(Description:="Index of the result set returnedr", IsRequired:=true)>
            Public Overridable Property page As Integer

            '''<Summary>
            '''Size of the result set returned
            '''</Summary>
            <ApiMember(Description:="Size of the result set returned", IsRequired:=true)>
            Public Overridable Property items As Integer

            '''<Summary>
            '''Total amount of pages / result sets
            '''</Summary>
            <ApiMember(Description:="Total amount of pages / result sets", IsRequired:=true)>
            Public Overridable Property totalPages As Integer

            '''<Summary>
            '''Total amount of results
            '''</Summary>
            <ApiMember(Description:="Total amount of results", IsRequired:=true)>
            Public Overridable Property totalResults As Integer

            '''<Summary>
            '''List of Users
            '''</Summary>
            <ApiMember(Description:="List of Users", IsRequired:=true)>
            Public Overridable Property elements As IEnumerable(Of GetUserResponse)
        End Class
    End Namespace
End Namespace

VB.NET GetUsers DTOs

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

HTTP + OTHER

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/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"page":0,"items":0,"totalPages":0,"totalResults":0}