digitaluapi

<back to all web services

ClientUserRegister

Requires Authentication
Required role:Client
The following routes are available for this service:
POST/clientuserregister

export class UserAuth
{
    public Id: number;
    public UserName: string;
    public Email: string;
    public PrimaryEmail: string;
    public PhoneNumber: string;
    public FirstName: string;
    public LastName: string;
    public DisplayName: string;
    public Company: string;
    public BirthDate?: string;
    public BirthDateRaw: string;
    public Address: string;
    public Address2: string;
    public City: string;
    public State: string;
    public Country: string;
    public Culture: string;
    public FullName: string;
    public Gender: string;
    public Language: string;
    public MailAddress: string;
    public Nickname: string;
    public PostalCode: string;
    public TimeZone: string;
    public Salt: string;
    public PasswordHash: string;
    public DigestHa1Hash: string;
    public Roles: string[];
    public Permissions: string[];
    public CreatedDate: string;
    public ModifiedDate: string;
    public InvalidLoginAttempts: number;
    public LastLoginAttempt?: string;
    public LockedDate?: string;
    public RecoveryToken: string;
    public RefId?: number;
    public RefIdStr: string;
    public Meta: { [index:string]: string; };

    public constructor(init?: Partial<UserAuth>) { (Object as any).assign(this, init); }
}

export class ClientUserRegister
{
    // @Validate(Validator="Email")
    public EMail: string;

    // @Validate(Validator="[NotNull,NotEmpty]")
    public FirstName: string;

    // @Validate(Validator="[NotNull,NotEmpty]")
    public LastName: string;

    // @Validate(Validator="[NotNull,NotEmpty]")
    public Password: string;

    public ConfirmPassword: string;
    // @Validate(Validator="NotNull")
    public Company: string;

    public InviteUserID: number;
    public Roles: string[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ClientUserRegister>) { (Object as any).assign(this, init); }
}

TypeScript ClientUserRegister DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"EMail":"String","FirstName":"String","LastName":"String","Password":"String","ConfirmPassword":"String","Company":"String","InviteUserID":0,"Roles":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"UserName":"String","Email":"String","PrimaryEmail":"String","PhoneNumber":"String","FirstName":"String","LastName":"String","DisplayName":"String","Company":"String","BirthDate":"0001-01-01T00:00:00.0000000","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":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","InvalidLoginAttempts":0,"LastLoginAttempt":"0001-01-01T00:00:00.0000000","LockedDate":"0001-01-01T00:00:00.0000000","RecoveryToken":"String","RefId":0,"RefIdStr":"String","Meta":{"String":"String"}}