Platform API

UpdateQuadrant

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

The following routes are available for this service:
All Verbs	/api/quadrantupdate/token
All Verbs	/api/quadrantupdate

**UpdateQuadrant** Parameters:
Name	Parameter	Data Type	Required	Description
Session	query	SessionModel	No

**SessionModel** Parameters:
Name	Parameter	Data Type	Required	Description
UserName	form	string	Yes	Create user session for the specified user name
AuthProvider	form	string	Yes	Local or External account
UserProfileId	form	Guid	Yes	Current user profile context
ApplianceId	form	Guid	Yes	Current appliance context
RoleId	form	Guid	Yes	Current role context
LicenseeConnectionId	form	Guid	Yes	Current licensee context
IsPersistent	form	bool	No	Has 'Remember Me' option been selected?
LicenseeContactId	form	Guid	Yes	Licensee contact id of the current licensee context
UserContactRoleConnectionId	form	Guid	Yes	Connection Id linking the current user profile to the current licensee context

**UpdateQuadrantResponse** Parameters:
Name	Parameter	Data Type	Required
PerspectiveSessionId	form	Guid	No
Settings	form	List<SettingModel>	No
Permissions	form	List<Guid>	No
ResponseStatus	form	ResponseStatus	No

**SettingModel** Parameters:
Name	Parameter	Data Type	Required
SettingId	form	Guid	No
SettingName	form	string	No
SettingValue	form	string	No

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