Platform API

<back to all web services

UpdateQuadrant

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

Requires Authentication
The following routes are available for this service:
All Verbs/api/quadrantupdate/token
All Verbs/api/quadrantupdate
UpdateQuadrant Parameters:
NameParameterData TypeRequiredDescription
SessionquerySessionModelNo
SessionModel Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringYesCreate user session for the specified user name
AuthProviderformstringYesLocal or External account
UserProfileIdformGuidYesCurrent user profile context
ApplianceIdformGuidYesCurrent appliance context
RoleIdformGuidYesCurrent role context
LicenseeConnectionIdformGuidYesCurrent licensee context
IsPersistentformboolNoHas 'Remember Me' option been selected?
LicenseeContactIdformGuidYesLicensee contact id of the current licensee context
UserContactRoleConnectionIdformGuidYesConnection Id linking the current user profile to the current licensee context
UpdateQuadrantResponse Parameters:
NameParameterData TypeRequiredDescription
PerspectiveSessionIdformGuidNo
SettingsformList<SettingModel>No
PermissionsformList<Guid>No
ResponseStatusformResponseStatusNo
SettingModel Parameters:
NameParameterData TypeRequiredDescription
SettingIdformGuidNo
SettingNameformstringNo
SettingValueformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Session":{"UserName":"String","AuthProvider":"String","UserProfileId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000","LicenseeConnectionId":"00000000-0000-0000-0000-000000000000","IsPersistent":false,"LicenseeContactId":"00000000-0000-0000-0000-000000000000","UserContactRoleConnectionId":"00000000-0000-0000-0000-000000000000"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PerspectiveSessionId":"00000000-0000-0000-0000-000000000000","Settings":[{"SettingId":"00000000-0000-0000-0000-000000000000","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"}}}