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
"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 SessionModel {
    /** @param {{UserName?:string,AuthProvider?:string,UserProfileId?:string,ApplianceId?:string,RoleId?:string,LicenseeConnectionId?:string,IsPersistent?:boolean,LicenseeContactId?:string,UserContactRoleConnectionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Create user session for the specified user name */
    UserName;
    /**
     * @type {string}
     * @description Local or External account */
    AuthProvider;
    /**
     * @type {string}
     * @description Current user profile context */
    UserProfileId;
    /**
     * @type {string}
     * @description Current appliance context */
    ApplianceId;
    /**
     * @type {string}
     * @description Current role context */
    RoleId;
    /**
     * @type {string}
     * @description Current licensee context */
    LicenseeConnectionId;
    /**
     * @type {boolean}
     * @description Has 'Remember Me' option been selected? */
    IsPersistent;
    /**
     * @type {string}
     * @description Licensee contact id of the current licensee context */
    LicenseeContactId;
    /**
     * @type {string}
     * @description Connection Id linking the current user profile to the current licensee context */
    UserContactRoleConnectionId;
}
export class UpdateQuadrant {
    /** @param {{Session?:SessionModel}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SessionModel} */
    Session;
}

JavaScript UpdateQuadrant DTOs

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