digitaluapi

<back to all web services

Register

auth

Sign Up

The following routes are available for this service:
PUT,POST/register
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Sign Up
    */
    @Api(Description="Sign Up")
    @DataContract
    public static class Register implements IPost, IMeta
    {
        @DataMember(Order=1)
        public String UserName = null;

        @DataMember(Order=2)
        public String FirstName = null;

        @DataMember(Order=3)
        public String LastName = null;

        @DataMember(Order=4)
        public String DisplayName = null;

        @DataMember(Order=5)
        public String Email = null;

        @DataMember(Order=6)
        public String Password = null;

        @DataMember(Order=7)
        public String ConfirmPassword = null;

        @DataMember(Order=8)
        public Boolean AutoLogin = null;

        @DataMember(Order=10)
        public String ErrorView = null;

        @DataMember(Order=11)
        public HashMap<String,String> Meta = null;
        
        public String getUserName() { return UserName; }
        public Register setUserName(String value) { this.UserName = value; return this; }
        public String getFirstName() { return FirstName; }
        public Register setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public Register setLastName(String value) { this.LastName = value; return this; }
        public String getDisplayName() { return DisplayName; }
        public Register setDisplayName(String value) { this.DisplayName = value; return this; }
        public String getEmail() { return Email; }
        public Register setEmail(String value) { this.Email = value; return this; }
        public String getPassword() { return Password; }
        public Register setPassword(String value) { this.Password = value; return this; }
        public String getConfirmPassword() { return ConfirmPassword; }
        public Register setConfirmPassword(String value) { this.ConfirmPassword = value; return this; }
        public Boolean isAutoLogin() { return AutoLogin; }
        public Register setAutoLogin(Boolean value) { this.AutoLogin = value; return this; }
        public String getErrorView() { return ErrorView; }
        public Register setErrorView(String value) { this.ErrorView = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public Register setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    @DataContract
    public static class RegisterResponse implements IMeta, IHasSessionId, IHasBearerToken
    {
        @DataMember(Order=1)
        public String UserId = null;

        @DataMember(Order=2)
        public String SessionId = null;

        @DataMember(Order=3)
        public String UserName = null;

        @DataMember(Order=4)
        public String ReferrerUrl = null;

        @DataMember(Order=5)
        public String BearerToken = null;

        @DataMember(Order=6)
        public String RefreshToken = null;

        @DataMember(Order=7)
        public Date RefreshTokenExpiry = null;

        @DataMember(Order=8)
        public ArrayList<String> Roles = null;

        @DataMember(Order=9)
        public ArrayList<String> Permissions = null;

        @DataMember(Order=10)
        public String RedirectUrl = null;

        @DataMember(Order=11)
        public ResponseStatus ResponseStatus = null;

        @DataMember(Order=12)
        public HashMap<String,String> Meta = null;
        
        public String getUserId() { return UserId; }
        public RegisterResponse setUserId(String value) { this.UserId = value; return this; }
        public String getSessionId() { return SessionId; }
        public RegisterResponse setSessionId(String value) { this.SessionId = value; return this; }
        public String getUserName() { return UserName; }
        public RegisterResponse setUserName(String value) { this.UserName = value; return this; }
        public String getReferrerUrl() { return ReferrerUrl; }
        public RegisterResponse setReferrerUrl(String value) { this.ReferrerUrl = value; return this; }
        public String getBearerToken() { return BearerToken; }
        public RegisterResponse setBearerToken(String value) { this.BearerToken = value; return this; }
        public String getRefreshToken() { return RefreshToken; }
        public RegisterResponse setRefreshToken(String value) { this.RefreshToken = value; return this; }
        public Date getRefreshTokenExpiry() { return RefreshTokenExpiry; }
        public RegisterResponse setRefreshTokenExpiry(Date value) { this.RefreshTokenExpiry = value; return this; }
        public ArrayList<String> getRoles() { return Roles; }
        public RegisterResponse setRoles(ArrayList<String> value) { this.Roles = value; return this; }
        public ArrayList<String> getPermissions() { return Permissions; }
        public RegisterResponse setPermissions(ArrayList<String> value) { this.Permissions = value; return this; }
        public String getRedirectUrl() { return RedirectUrl; }
        public RegisterResponse setRedirectUrl(String value) { this.RedirectUrl = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RegisterResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public RegisterResponse setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

}

Java Register DTOs

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

HTTP + JSV

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

{
	UserId: String,
	SessionId: String,
	UserName: String,
	ReferrerUrl: String,
	BearerToken: String,
	RefreshToken: String,
	RefreshTokenExpiry: 0001-01-01,
	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
	}
}