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
"use strict";
export class SettingModel {
    /** @param {{SettingId?:string,SettingName?:string,SettingValue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SettingId;
    /** @type {string} */
    SettingName;
    /** @type {string} */
    SettingValue;
}
export class UpdateQuadrantResponse {
    /** @param {{PerspectiveSessionId?:string,Settings?:SettingModel[],Permissions?:string[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PerspectiveSessionId;
    /** @type {SettingModel[]} */
    Settings;
    /** @type {string[]} */
    Permissions;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SwitchProfile {
    /** @param {{UserProfileId?:string,IsPersistent?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the user profile to switch to. */
    UserProfileId;
    /**
     * @type {boolean}
     * @description Has 'Remember Me' option been selected? */
    IsPersistent;
}

JavaScript SwitchProfile DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"UserProfileId":"00000000-0000-0000-0000-000000000000","IsPersistent":false}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}