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
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 GetUser() = 
        ///<summary>
        ///User's UserID
        ///</summary>
        [<ApiMember(Description="User's UserID", IsRequired=true)>]
        member val userId:String = null with get,set

F# 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>