Platform API

<back to all web services

UpdateQuadrant

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

export class SettingModel
{
    public SettingId: string;
    public SettingName: string;
    public SettingValue: string;

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

export class UpdateQuadrantResponse
{
    public PerspectiveSessionId: string;
    public Settings: SettingModel[];
    public Permissions: string[];
    public ResponseStatus: ResponseStatus;

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

export class SessionModel
{
    /** @description Create user session for the specified user name */
    // @ApiMember(Description="Create user session for the specified user name", IsRequired=true, Name="UserName")
    public UserName: string;

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

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

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

    /** @description Current role context */
    // @ApiMember(Description="Current role context", IsRequired=true, Name="RoleId")
    public RoleId: string;

    /** @description Current licensee context */
    // @ApiMember(Description="Current licensee context", IsRequired=true, Name="LicenseeConnectionId")
    public LicenseeConnectionId: string;

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

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

    /** @description 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 UserContactRoleConnectionId: string;

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

/** @description 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")
export class UpdateQuadrant
{
    public Session: SessionModel;

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

TypeScript 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
		}
	}
}