digitaluapi

ClientRegister

**Requires Authentication**
Required role:	Partner

The following routes are available for this service:
POST	/clientregister

"use strict";
export class UserAuth {
    /** @param {{Id?:number,UserName?:string,Email?:string,PrimaryEmail?:string,PhoneNumber?:string,FirstName?:string,LastName?:string,DisplayName?:string,Company?:string,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?:string,Roles?:string[],Permissions?:string[],CreatedDate?:string,ModifiedDate?:string,InvalidLoginAttempts?:number,LastLoginAttempt?:string,LockedDate?:string,RecoveryToken?:string,RefId?:number,RefIdStr?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    UserName;
    /** @type {string} */
    Email;
    /** @type {string} */
    PrimaryEmail;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    DisplayName;
    /** @type {string} */
    Company;
    /** @type {?string} */
    BirthDate;
    /** @type {string} */
    BirthDateRaw;
    /** @type {string} */
    Address;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Country;
    /** @type {string} */
    Culture;
    /** @type {string} */
    FullName;
    /** @type {string} */
    Gender;
    /** @type {string} */
    Language;
    /** @type {string} */
    MailAddress;
    /** @type {string} */
    Nickname;
    /** @type {string} */
    PostalCode;
    /** @type {string} */
    TimeZone;
    /** @type {string} */
    Salt;
    /** @type {string} */
    PasswordHash;
    /** @type {string} */
    DigestHa1Hash;
    /** @type {string[]} */
    Roles;
    /** @type {string[]} */
    Permissions;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    ModifiedDate;
    /** @type {number} */
    InvalidLoginAttempts;
    /** @type {?string} */
    LastLoginAttempt;
    /** @type {?string} */
    LockedDate;
    /** @type {string} */
    RecoveryToken;
    /** @type {?number} */
    RefId;
    /** @type {string} */
    RefIdStr;
    /** @type {{ [index:string]: string; }} */
    Meta;
}
export class ClientRegister {
    /** @param {{EMail?:string,FirstName?:string,LastName?:string,Password?:string,ConfirmPassword?:string,Company?:string,PartnerUserID?:number,Roles?:string[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    EMail;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    Password;
    /** @type {string} */
    ConfirmPassword;
    /** @type {string} */
    Company;
    /** @type {number} */
    PartnerUserID;
    /** @type {string[]} */
    Roles;
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript 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>