Platform API

<back to all web services

UpdateQuadrant

Update quadrant context - create a new session, retrieve settings and return new JWT Token

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Update quadrant context - create a new session, retrieve settings and return new JWT Token
    */
    @Api(Description="Update quadrant context - create a new session, retrieve settings and return new JWT Token")
    public static class UpdateQuadrant
    {
        public SessionModel Session = null;
        
        public SessionModel getSession() { return Session; }
        public UpdateQuadrant setSession(SessionModel value) { this.Session = value; return this; }
    }

    public static class SessionModel
    {
        /**
        * Create user session for the specified user name
        */
        @ApiMember(Description="Create user session for the specified user name", IsRequired=true, Name="UserName")
        public String UserName = null;

        /**
        * Local or External account
        */
        @ApiMember(Description="Local or External account", IsRequired=true, Name="AuthProvider")
        public String AuthProvider = null;

        /**
        * Current user profile context
        */
        @ApiMember(Description="Current user profile context", IsRequired=true, Name="UserProfileId")
        public UUID UserProfileId = null;

        /**
        * Current appliance context
        */
        @ApiMember(Description="Current appliance context", IsRequired=true, Name="Appliance")
        public UUID ApplianceId = null;

        /**
        * Current role context
        */
        @ApiMember(Description="Current role context", IsRequired=true, Name="RoleId")
        public UUID RoleId = null;

        /**
        * Current licensee context
        */
        @ApiMember(Description="Current licensee context", IsRequired=true, Name="LicenseeConnectionId")
        public UUID LicenseeConnectionId = null;

        /**
        * Has 'Remember Me' option been selected?
        */
        @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
        public Boolean IsPersistent = null;

        /**
        * Licensee contact id of the current licensee context
        */
        @ApiMember(Description="Licensee contact id of the current licensee context", IsRequired=true, Name="LicenseeContactId")
        public UUID LicenseeContactId = null;

        /**
        * Connection Id linking the current user profile to the current licensee context
        */
        @ApiMember(Description="Connection Id linking the current user profile to the current licensee context", IsRequired=true, Name="UserContactRoleConnectionId")
        public UUID UserContactRoleConnectionId = null;
        
        public String getUserName() { return UserName; }
        public SessionModel setUserName(String value) { this.UserName = value; return this; }
        public String getAuthProvider() { return AuthProvider; }
        public SessionModel setAuthProvider(String value) { this.AuthProvider = value; return this; }
        public UUID getUserProfileId() { return UserProfileId; }
        public SessionModel setUserProfileId(UUID value) { this.UserProfileId = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public SessionModel setApplianceId(UUID value) { this.ApplianceId = value; return this; }
        public UUID getRoleId() { return RoleId; }
        public SessionModel setRoleId(UUID value) { this.RoleId = value; return this; }
        public UUID getLicenseeConnectionId() { return LicenseeConnectionId; }
        public SessionModel setLicenseeConnectionId(UUID value) { this.LicenseeConnectionId = value; return this; }
        public Boolean getIsPersistent() { return IsPersistent; }
        public SessionModel setIsPersistent(Boolean value) { this.IsPersistent = value; return this; }
        public UUID getLicenseeContactId() { return LicenseeContactId; }
        public SessionModel setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
        public UUID getUserContactRoleConnectionId() { return UserContactRoleConnectionId; }
        public SessionModel setUserContactRoleConnectionId(UUID value) { this.UserContactRoleConnectionId = value; return this; }
    }

    public static class UpdateQuadrantResponse
    {
        public UUID PerspectiveSessionId = null;
        public ArrayList<SettingModel> Settings = null;
        public ArrayList<UUID> Permissions = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getPerspectiveSessionId() { return PerspectiveSessionId; }
        public UpdateQuadrantResponse setPerspectiveSessionId(UUID value) { this.PerspectiveSessionId = value; return this; }
        public ArrayList<SettingModel> getSettings() { return Settings; }
        public UpdateQuadrantResponse setSettings(ArrayList<SettingModel> value) { this.Settings = value; return this; }
        public ArrayList<UUID> getPermissions() { return Permissions; }
        public UpdateQuadrantResponse setPermissions(ArrayList<UUID> value) { this.Permissions = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public UpdateQuadrantResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class SettingModel
    {
        public UUID SettingId = null;
        public String SettingName = null;
        public String SettingValue = null;
        
        public UUID getSettingId() { return SettingId; }
        public SettingModel setSettingId(UUID value) { this.SettingId = value; return this; }
        public String getSettingName() { return SettingName; }
        public SettingModel setSettingName(String value) { this.SettingName = value; return this; }
        public String getSettingValue() { return SettingValue; }
        public SettingModel setSettingValue(String value) { this.SettingValue = value; return this; }
    }

}

Java UpdateQuadrant DTOs

POST /api/quadrantupdate/token HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Session: 
	{
		UserName: String,
		AuthProvider: String,
		IsPersistent: False
	}
}

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

{
	Settings: 
	[
		{
			SettingName: String,
			SettingValue: String
		}
	],
	Permissions: 
	[
		00000000-0000-0000-0000-000000000000
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}