digitaluapi

<back to all web services

ClientRegister

Requires Authentication
Required role:Partner
The following routes are available for this service:
POST/clientregister
import 'package:servicestack/servicestack.dart';
import 'dart:collection';

class UserAuth implements IConvertible
{
    int? Id;
    String? UserName;
    String? Email;
    String? PrimaryEmail;
    String? PhoneNumber;
    String? FirstName;
    String? LastName;
    String? DisplayName;
    String? Company;
    DateTime? BirthDate;
    String? BirthDateRaw;
    String? Address;
    String? Address2;
    String? City;
    String? State;
    String? Country;
    String? Culture;
    String? FullName;
    String? Gender;
    String? Language;
    String? MailAddress;
    String? Nickname;
    String? PostalCode;
    String? TimeZone;
    String? Salt;
    String? PasswordHash;
    String? DigestHa1Hash;
    List<String>? Roles;
    List<String>? Permissions;
    DateTime? CreatedDate;
    DateTime? ModifiedDate;
    int? InvalidLoginAttempts;
    DateTime? LastLoginAttempt;
    DateTime? LockedDate;
    String? RecoveryToken;
    int? RefId;
    String? RefIdStr;
    Map<String,String?>? Meta;

    UserAuth({this.Id,this.UserName,this.Email,this.PrimaryEmail,this.PhoneNumber,this.FirstName,this.LastName,this.DisplayName,this.Company,this.BirthDate,this.BirthDateRaw,this.Address,this.Address2,this.City,this.State,this.Country,this.Culture,this.FullName,this.Gender,this.Language,this.MailAddress,this.Nickname,this.PostalCode,this.TimeZone,this.Salt,this.PasswordHash,this.DigestHa1Hash,this.Roles,this.Permissions,this.CreatedDate,this.ModifiedDate,this.InvalidLoginAttempts,this.LastLoginAttempt,this.LockedDate,this.RecoveryToken,this.RefId,this.RefIdStr,this.Meta});
    UserAuth.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        UserName = json['UserName'];
        Email = json['Email'];
        PrimaryEmail = json['PrimaryEmail'];
        PhoneNumber = json['PhoneNumber'];
        FirstName = json['FirstName'];
        LastName = json['LastName'];
        DisplayName = json['DisplayName'];
        Company = json['Company'];
        BirthDate = JsonConverters.fromJson(json['BirthDate'],'DateTime',context!);
        BirthDateRaw = json['BirthDateRaw'];
        Address = json['Address'];
        Address2 = json['Address2'];
        City = json['City'];
        State = json['State'];
        Country = json['Country'];
        Culture = json['Culture'];
        FullName = json['FullName'];
        Gender = json['Gender'];
        Language = json['Language'];
        MailAddress = json['MailAddress'];
        Nickname = json['Nickname'];
        PostalCode = json['PostalCode'];
        TimeZone = json['TimeZone'];
        Salt = json['Salt'];
        PasswordHash = json['PasswordHash'];
        DigestHa1Hash = json['DigestHa1Hash'];
        Roles = JsonConverters.fromJson(json['Roles'],'List<String>',context!);
        Permissions = JsonConverters.fromJson(json['Permissions'],'List<String>',context!);
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
        InvalidLoginAttempts = json['InvalidLoginAttempts'];
        LastLoginAttempt = JsonConverters.fromJson(json['LastLoginAttempt'],'DateTime',context!);
        LockedDate = JsonConverters.fromJson(json['LockedDate'],'DateTime',context!);
        RecoveryToken = json['RecoveryToken'];
        RefId = json['RefId'];
        RefIdStr = json['RefIdStr'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'UserName': UserName,
        'Email': Email,
        'PrimaryEmail': PrimaryEmail,
        'PhoneNumber': PhoneNumber,
        'FirstName': FirstName,
        'LastName': LastName,
        'DisplayName': DisplayName,
        'Company': Company,
        'BirthDate': JsonConverters.toJson(BirthDate,'DateTime',context!),
        'BirthDateRaw': BirthDateRaw,
        'Address': Address,
        'Address2': Address2,
        'City': City,
        'State': State,
        'Country': Country,
        'Culture': Culture,
        'FullName': FullName,
        'Gender': Gender,
        'Language': Language,
        'MailAddress': MailAddress,
        'Nickname': Nickname,
        'PostalCode': PostalCode,
        'TimeZone': TimeZone,
        'Salt': Salt,
        'PasswordHash': PasswordHash,
        'DigestHa1Hash': DigestHa1Hash,
        'Roles': JsonConverters.toJson(Roles,'List<String>',context!),
        'Permissions': JsonConverters.toJson(Permissions,'List<String>',context!),
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
        'InvalidLoginAttempts': InvalidLoginAttempts,
        'LastLoginAttempt': JsonConverters.toJson(LastLoginAttempt,'DateTime',context!),
        'LockedDate': JsonConverters.toJson(LockedDate,'DateTime',context!),
        'RecoveryToken': RecoveryToken,
        'RefId': RefId,
        'RefIdStr': RefIdStr,
        'Meta': Meta
    };

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

class ClientRegister implements IConvertible
{
    // @Validate(Validator="Email")
    String? EMail;

    // @Validate(Validator="[NotNull,NotEmpty]")
    String? FirstName;

    // @Validate(Validator="[NotNull,NotEmpty]")
    String? LastName;

    // @Validate(Validator="[NotNull,NotEmpty]")
    String? Password;

    String? ConfirmPassword;
    // @Validate(Validator="NotNull")
    String? Company;

    int? PartnerUserID;
    List<String>? Roles;
    ResponseStatus? ResponseStatus;

    ClientRegister({this.EMail,this.FirstName,this.LastName,this.Password,this.ConfirmPassword,this.Company,this.PartnerUserID,this.Roles,this.ResponseStatus});
    ClientRegister.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        EMail = json['EMail'];
        FirstName = json['FirstName'];
        LastName = json['LastName'];
        Password = json['Password'];
        ConfirmPassword = json['ConfirmPassword'];
        Company = json['Company'];
        PartnerUserID = json['PartnerUserID'];
        Roles = JsonConverters.fromJson(json['Roles'],'List<String>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'EMail': EMail,
        'FirstName': FirstName,
        'LastName': LastName,
        'Password': Password,
        'ConfirmPassword': ConfirmPassword,
        'Company': Company,
        'PartnerUserID': PartnerUserID,
        'Roles': JsonConverters.toJson(Roles,'List<String>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

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

Dart ClientRegister 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 /clientregister HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ClientRegister xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Company>String</Company>
  <ConfirmPassword>String</ConfirmPassword>
  <EMail>String</EMail>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <PartnerUserID>0</PartnerUserID>
  <Password>String</Password>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</ClientRegister>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAuth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Address>String</Address>
  <Address2>String</Address2>
  <BirthDate>0001-01-01T00:00:00</BirthDate>
  <BirthDateRaw>String</BirthDateRaw>
  <City>String</City>
  <Company>String</Company>
  <Country>String</Country>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Culture>String</Culture>
  <DigestHa1Hash>String</DigestHa1Hash>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <FullName>String</FullName>
  <Gender>String</Gender>
  <Id>0</Id>
  <InvalidLoginAttempts>0</InvalidLoginAttempts>
  <Language>String</Language>
  <LastLoginAttempt>0001-01-01T00:00:00</LastLoginAttempt>
  <LastName>String</LastName>
  <LockedDate>0001-01-01T00:00:00</LockedDate>
  <MailAddress>String</MailAddress>
  <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>
  <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
  <Nickname>String</Nickname>
  <PasswordHash>String</PasswordHash>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <PhoneNumber>String</PhoneNumber>
  <PostalCode>String</PostalCode>
  <PrimaryEmail>String</PrimaryEmail>
  <RecoveryToken>String</RecoveryToken>
  <RefId>0</RefId>
  <RefIdStr>String</RefIdStr>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Salt>String</Salt>
  <State>String</State>
  <TimeZone>String</TimeZone>
  <UserName>String</UserName>
</UserAuth>