digitaluapi

<back to all web services

ClientUserClientRegister

Requires Authentication
Required role:Client
The following routes are available for this service:
POST/clientuserclientregister
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ClientUserClientRegister
    {
        @Validate(Validator="[NotNull,NotEmpty]")
        public UUID CompanyGuid = null;

        @Validate(Validator="Email")
        public String EMail = null;

        @Validate(Validator="[NotNull,NotEmpty]")
        public String FirstName = null;

        @Validate(Validator="[NotNull,NotEmpty]")
        public String LastName = null;

        @Validate(Validator="[NotNull,NotEmpty]")
        public String Password = null;

        public String ConfirmPassword = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getCompanyGuid() { return CompanyGuid; }
        public ClientUserClientRegister setCompanyGuid(UUID value) { this.CompanyGuid = value; return this; }
        public String getEMail() { return EMail; }
        public ClientUserClientRegister setEMail(String value) { this.EMail = value; return this; }
        public String getFirstName() { return FirstName; }
        public ClientUserClientRegister setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public ClientUserClientRegister setLastName(String value) { this.LastName = value; return this; }
        public String getPassword() { return Password; }
        public ClientUserClientRegister setPassword(String value) { this.Password = value; return this; }
        public String getConfirmPassword() { return ConfirmPassword; }
        public ClientUserClientRegister setConfirmPassword(String value) { this.ConfirmPassword = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ClientUserClientRegister setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class UserAuth
    {
        public Integer Id = null;
        public String UserName = null;
        public String Email = null;
        public String PrimaryEmail = null;
        public String PhoneNumber = null;
        public String FirstName = null;
        public String LastName = null;
        public String DisplayName = null;
        public String Company = null;
        public Date BirthDate = null;
        public String BirthDateRaw = null;
        public String Address = null;
        public String Address2 = null;
        public String City = null;
        public String State = null;
        public String Country = null;
        public String Culture = null;
        public String FullName = null;
        public String Gender = null;
        public String Language = null;
        public String MailAddress = null;
        public String Nickname = null;
        public String PostalCode = null;
        public String TimeZone = null;
        public String Salt = null;
        public String PasswordHash = null;
        public String DigestHa1Hash = null;
        public ArrayList<String> Roles = null;
        public ArrayList<String> Permissions = null;
        public Date CreatedDate = null;
        public Date ModifiedDate = null;
        public Integer InvalidLoginAttempts = null;
        public Date LastLoginAttempt = null;
        public Date LockedDate = null;
        public String RecoveryToken = null;
        public Integer RefId = null;
        public String RefIdStr = null;
        public HashMap<String,String> Meta = null;
        
        public Integer getId() { return Id; }
        public UserAuth setId(Integer value) { this.Id = value; return this; }
        public String getUserName() { return UserName; }
        public UserAuth setUserName(String value) { this.UserName = value; return this; }
        public String getEmail() { return Email; }
        public UserAuth setEmail(String value) { this.Email = value; return this; }
        public String getPrimaryEmail() { return PrimaryEmail; }
        public UserAuth setPrimaryEmail(String value) { this.PrimaryEmail = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public UserAuth setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public String getFirstName() { return FirstName; }
        public UserAuth setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public UserAuth setLastName(String value) { this.LastName = value; return this; }
        public String getDisplayName() { return DisplayName; }
        public UserAuth setDisplayName(String value) { this.DisplayName = value; return this; }
        public String getCompany() { return Company; }
        public UserAuth setCompany(String value) { this.Company = value; return this; }
        public Date getBirthDate() { return BirthDate; }
        public UserAuth setBirthDate(Date value) { this.BirthDate = value; return this; }
        public String getBirthDateRaw() { return BirthDateRaw; }
        public UserAuth setBirthDateRaw(String value) { this.BirthDateRaw = value; return this; }
        public String getAddress() { return Address; }
        public UserAuth setAddress(String value) { this.Address = value; return this; }
        public String getAddress2() { return Address2; }
        public UserAuth setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public UserAuth setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public UserAuth setState(String value) { this.State = value; return this; }
        public String getCountry() { return Country; }
        public UserAuth setCountry(String value) { this.Country = value; return this; }
        public String getCulture() { return Culture; }
        public UserAuth setCulture(String value) { this.Culture = value; return this; }
        public String getFullName() { return FullName; }
        public UserAuth setFullName(String value) { this.FullName = value; return this; }
        public String getGender() { return Gender; }
        public UserAuth setGender(String value) { this.Gender = value; return this; }
        public String getLanguage() { return Language; }
        public UserAuth setLanguage(String value) { this.Language = value; return this; }
        public String getMailAddress() { return MailAddress; }
        public UserAuth setMailAddress(String value) { this.MailAddress = value; return this; }
        public String getNickname() { return Nickname; }
        public UserAuth setNickname(String value) { this.Nickname = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public UserAuth setPostalCode(String value) { this.PostalCode = value; return this; }
        public String getTimeZone() { return TimeZone; }
        public UserAuth setTimeZone(String value) { this.TimeZone = value; return this; }
        public String getSalt() { return Salt; }
        public UserAuth setSalt(String value) { this.Salt = value; return this; }
        public String getPasswordHash() { return PasswordHash; }
        public UserAuth setPasswordHash(String value) { this.PasswordHash = value; return this; }
        public String getDigestHa1Hash() { return DigestHa1Hash; }
        public UserAuth setDigestHa1Hash(String value) { this.DigestHa1Hash = value; return this; }
        public ArrayList<String> getRoles() { return Roles; }
        public UserAuth setRoles(ArrayList<String> value) { this.Roles = value; return this; }
        public ArrayList<String> getPermissions() { return Permissions; }
        public UserAuth setPermissions(ArrayList<String> value) { this.Permissions = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public UserAuth setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public UserAuth setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
        public Integer getInvalidLoginAttempts() { return InvalidLoginAttempts; }
        public UserAuth setInvalidLoginAttempts(Integer value) { this.InvalidLoginAttempts = value; return this; }
        public Date getLastLoginAttempt() { return LastLoginAttempt; }
        public UserAuth setLastLoginAttempt(Date value) { this.LastLoginAttempt = value; return this; }
        public Date getLockedDate() { return LockedDate; }
        public UserAuth setLockedDate(Date value) { this.LockedDate = value; return this; }
        public String getRecoveryToken() { return RecoveryToken; }
        public UserAuth setRecoveryToken(String value) { this.RecoveryToken = value; return this; }
        public Integer getRefId() { return RefId; }
        public UserAuth setRefId(Integer value) { this.RefId = value; return this; }
        public String getRefIdStr() { return RefIdStr; }
        public UserAuth setRefIdStr(String value) { this.RefIdStr = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public UserAuth setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

}

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

<ClientUserClientRegister xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CompanyGuid>00000000-0000-0000-0000-000000000000</CompanyGuid>
  <ConfirmPassword>String</ConfirmPassword>
  <EMail>String</EMail>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <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>
</ClientUserClientRegister>
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>