digitaluapi

<back to all web services

Register

auth

Sign Up

The following routes are available for this service:
PUT,POST/register

// @DataContract
export class RegisterResponse implements IMeta, IHasSessionId, IHasBearerToken
{
    // @DataMember(Order=1)
    public UserId: string;

    // @DataMember(Order=2)
    public SessionId: string;

    // @DataMember(Order=3)
    public UserName: string;

    // @DataMember(Order=4)
    public ReferrerUrl: string;

    // @DataMember(Order=5)
    public BearerToken: string;

    // @DataMember(Order=6)
    public RefreshToken: string;

    // @DataMember(Order=7)
    public RefreshTokenExpiry?: string;

    // @DataMember(Order=8)
    public Roles: string[];

    // @DataMember(Order=9)
    public Permissions: string[];

    // @DataMember(Order=10)
    public RedirectUrl: string;

    // @DataMember(Order=11)
    public ResponseStatus: ResponseStatus;

    // @DataMember(Order=12)
    public Meta: { [index:string]: string; };

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

/** @description Sign Up */
// @Api(Description="Sign Up")
// @DataContract
export class Register implements IPost, IMeta
{
    // @DataMember(Order=1)
    public UserName: string;

    // @DataMember(Order=2)
    public FirstName: string;

    // @DataMember(Order=3)
    public LastName: string;

    // @DataMember(Order=4)
    public DisplayName: string;

    // @DataMember(Order=5)
    public Email: string;

    // @DataMember(Order=6)
    public Password: string;

    // @DataMember(Order=7)
    public ConfirmPassword: string;

    // @DataMember(Order=8)
    public AutoLogin?: boolean;

    // @DataMember(Order=10)
    public ErrorView: string;

    // @DataMember(Order=11)
    public Meta: { [index:string]: string; };

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

TypeScript Register DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"UserName":"String","FirstName":"String","LastName":"String","DisplayName":"String","Email":"String","Password":"String","ConfirmPassword":"String","AutoLogin":false,"ErrorView":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserId":"String","SessionId":"String","UserName":"String","ReferrerUrl":"String","BearerToken":"String","RefreshToken":"String","RefreshTokenExpiry":"0001-01-01T00:00:00.0000000","Roles":["String"],"Permissions":["String"],"RedirectUrl":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Meta":{"String":"String"}}