Richemont.Booster2.PublicApi

<back to all web services

GetUser

Requires Authentication
The following routes are available for this service:
GET/users/{userId}Get user if exists and is not disabled
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 GetUser
            '''<Summary>
            '''User's UserID
            '''</Summary>
            <ApiMember(Description:="User's UserID", IsRequired:=true)>
            Public Overridable Property userId As String
        End Class

        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
    End Namespace
End Namespace

VB.NET GetUser DTOs

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/{userId} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Security.ServiceModel">
  <accountLocked>false</accountLocked>
  <culture>String</culture>
  <emailAddress>String</emailAddress>
  <firstName>String</firstName>
  <lastName>String</lastName>
  <passwordExpirationDate>String</passwordExpirationDate>
  <passwordMustBeChanged>false</passwordMustBeChanged>
  <userId>00000000-0000-0000-0000-000000000000</userId>
  <userType>String</userType>
</GetUserResponse>