Platform API

<back to all web services

SwitchProfile

Switch to the specified profile - create a new session, retrieve settings and return new JWT Token

Requires Authentication
The following routes are available for this service:
All Verbs/api/profiles/{UserProfileId}/switch/token
All Verbs/api/profiles/{UserProfileId}/switch
SwitchProfile Parameters:
NameParameterData TypeRequiredDescription
UserProfileIdpathGuidNoId of the user profile to switch to.
IsPersistentqueryboolNoHas 'Remember Me' option been selected?
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/profiles/{UserProfileId}/switch/token HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"UserProfileId":"00000000-0000-0000-0000-000000000000","IsPersistent":false}
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"}}}