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
import 'package:servicestack/servicestack.dart';

class GetUserResponse implements IConvertible
{
    /**
    * Unique Identifier of a User
    */
    // @ApiMember(Description="Unique Identifier of a User", IsRequired=true)
    String? userId;

    /**
    * User's Email address
    */
    // @ApiMember(Description="User's Email address", IsRequired=true)
    String? emailAddress;

    /**
    * First Name
    */
    // @ApiMember(Description="First Name", IsRequired=true)
    String? firstName;

    /**
    * Last Name
    */
    // @ApiMember(Description="Last Name", IsRequired=true)
    String? lastName;

    /**
    * User's Password Expiration Date
    */
    // @ApiMember(Description="User's Password Expiration Date")
    String? passwordExpirationDate;

    /**
    * If the User must change the password
    */
    // @ApiMember(Description="If the User must change the password", IsRequired=true)
    bool? passwordMustBeChanged;

    /**
    * User Type of the User
    */
    // @ApiMember(Description="User Type of the User", IsRequired=true)
    String? userType;

    /**
    * Culture ID of the User
    */
    // @ApiMember(Description="Culture ID of the User", IsRequired=true)
    String? culture;

    /**
    * If the User account is locked
    */
    // @ApiMember(Description="If the User account is locked", IsRequired=true)
    bool? accountLocked;

    GetUserResponse({this.userId,this.emailAddress,this.firstName,this.lastName,this.passwordExpirationDate,this.passwordMustBeChanged,this.userType,this.culture,this.accountLocked});
    GetUserResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userId = json['userId'];
        emailAddress = json['emailAddress'];
        firstName = json['firstName'];
        lastName = json['lastName'];
        passwordExpirationDate = json['passwordExpirationDate'];
        passwordMustBeChanged = json['passwordMustBeChanged'];
        userType = json['userType'];
        culture = json['culture'];
        accountLocked = json['accountLocked'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': userId,
        'emailAddress': emailAddress,
        'firstName': firstName,
        'lastName': lastName,
        'passwordExpirationDate': passwordExpirationDate,
        'passwordMustBeChanged': passwordMustBeChanged,
        'userType': userType,
        'culture': culture,
        'accountLocked': accountLocked
    };

    getTypeName() => "GetUserResponse";
    TypeContext? context = _ctx;
}

class GetUser implements IConvertible
{
    /**
    * User's UserID
    */
    // @ApiMember(Description="User's UserID", IsRequired=true)
    String? userId;

    GetUser({this.userId});
    GetUser.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userId = json['userId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': userId
    };

    getTypeName() => "GetUser";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev_api_booster.richemont.com', types: <String, TypeInfo> {
    'GetUserResponse': TypeInfo(TypeOf.Class, create:() => GetUserResponse()),
    'GetUser': TypeInfo(TypeOf.Class, create:() => GetUser()),
});

Dart GetUser 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/{userId} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"userId":"00000000000000000000000000000000","emailAddress":"String","firstName":"String","lastName":"String","passwordExpirationDate":"String","passwordMustBeChanged":false,"userType":"String","culture":"String","accountLocked":false}