digitaluapi

<back to all web services

Register

auth

Sign Up

The following routes are available for this service:
PUT,POST/register
import 'package:servicestack/servicestack.dart';

// @DataContract
class RegisterResponse implements IMeta, IHasSessionId, IHasBearerToken, IConvertible
{
    // @DataMember(Order=1)
    String? UserId;

    // @DataMember(Order=2)
    String? SessionId;

    // @DataMember(Order=3)
    String? UserName;

    // @DataMember(Order=4)
    String? ReferrerUrl;

    // @DataMember(Order=5)
    String? BearerToken;

    // @DataMember(Order=6)
    String? RefreshToken;

    // @DataMember(Order=7)
    DateTime? RefreshTokenExpiry;

    // @DataMember(Order=8)
    List<String>? Roles;

    // @DataMember(Order=9)
    List<String>? Permissions;

    // @DataMember(Order=10)
    String? RedirectUrl;

    // @DataMember(Order=11)
    ResponseStatus? ResponseStatus;

    // @DataMember(Order=12)
    Map<String,String?>? Meta;

    RegisterResponse({this.UserId,this.SessionId,this.UserName,this.ReferrerUrl,this.BearerToken,this.RefreshToken,this.RefreshTokenExpiry,this.Roles,this.Permissions,this.RedirectUrl,this.ResponseStatus,this.Meta});
    RegisterResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserId = json['UserId'];
        SessionId = json['SessionId'];
        UserName = json['UserName'];
        ReferrerUrl = json['ReferrerUrl'];
        BearerToken = json['BearerToken'];
        RefreshToken = json['RefreshToken'];
        RefreshTokenExpiry = JsonConverters.fromJson(json['RefreshTokenExpiry'],'DateTime',context!);
        Roles = JsonConverters.fromJson(json['Roles'],'List<String>',context!);
        Permissions = JsonConverters.fromJson(json['Permissions'],'List<String>',context!);
        RedirectUrl = json['RedirectUrl'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UserId': UserId,
        'SessionId': SessionId,
        'UserName': UserName,
        'ReferrerUrl': ReferrerUrl,
        'BearerToken': BearerToken,
        'RefreshToken': RefreshToken,
        'RefreshTokenExpiry': JsonConverters.toJson(RefreshTokenExpiry,'DateTime',context!),
        'Roles': JsonConverters.toJson(Roles,'List<String>',context!),
        'Permissions': JsonConverters.toJson(Permissions,'List<String>',context!),
        'RedirectUrl': RedirectUrl,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Meta': Meta
    };

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

/**
* Sign Up
*/
// @Api(Description="Sign Up")
// @DataContract
class Register implements IPost, IMeta, IConvertible
{
    // @DataMember(Order=1)
    String? UserName;

    // @DataMember(Order=2)
    String? FirstName;

    // @DataMember(Order=3)
    String? LastName;

    // @DataMember(Order=4)
    String? DisplayName;

    // @DataMember(Order=5)
    String? Email;

    // @DataMember(Order=6)
    String? Password;

    // @DataMember(Order=7)
    String? ConfirmPassword;

    // @DataMember(Order=8)
    bool? AutoLogin;

    // @DataMember(Order=10)
    String? ErrorView;

    // @DataMember(Order=11)
    Map<String,String?>? Meta;

    Register({this.UserName,this.FirstName,this.LastName,this.DisplayName,this.Email,this.Password,this.ConfirmPassword,this.AutoLogin,this.ErrorView,this.Meta});
    Register.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserName = json['UserName'];
        FirstName = json['FirstName'];
        LastName = json['LastName'];
        DisplayName = json['DisplayName'];
        Email = json['Email'];
        Password = json['Password'];
        ConfirmPassword = json['ConfirmPassword'];
        AutoLogin = json['AutoLogin'];
        ErrorView = json['ErrorView'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UserName': UserName,
        'FirstName': FirstName,
        'LastName': LastName,
        'DisplayName': DisplayName,
        'Email': Email,
        'Password': Password,
        'ConfirmPassword': ConfirmPassword,
        'AutoLogin': AutoLogin,
        'ErrorView': ErrorView,
        'Meta': Meta
    };

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

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
});

Dart Register 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.

POST /register HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Register xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <UserName>String</UserName>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <Password>String</Password>
  <ConfirmPassword>String</ConfirmPassword>
  <AutoLogin>false</AutoLogin>
  <ErrorView>String</ErrorView>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</Register>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <UserId>String</UserId>
  <SessionId>String</SessionId>
  <UserName>String</UserName>
  <ReferrerUrl>String</ReferrerUrl>
  <BearerToken>String</BearerToken>
  <RefreshToken>String</RefreshToken>
  <RefreshTokenExpiry>0001-01-01T00:00:00</RefreshTokenExpiry>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <RedirectUrl>String</RedirectUrl>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</RegisterResponse>