Platform API

<back to all web services

GetQuadrant

Get quadrant data for the perspective session id specified in the authentication token

Requires Authentication
The following routes are available for this service:
All Verbs/api/quadrant
All Verbs/api/core/quadrant
"use strict";
export class ListItemModel {
    /** @param {{ListItemId?:string,Name?:string,Description?:string,ShortName?:string,IsDefault?:boolean,Order?:number,ListItemTrafficLightId?:string,PrimaryListItemImageId?:string,PrimaryListItemImageUrl?:string,PrimaryImageThumbnailUrl?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ListItemId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    ShortName;
    /** @type {boolean} */
    IsDefault;
    /** @type {number} */
    Order;
    /** @type {string} */
    ListItemTrafficLightId;
    /** @type {string} */
    PrimaryListItemImageId;
    /** @type {string} */
    PrimaryListItemImageUrl;
    /** @type {string} */
    PrimaryImageThumbnailUrl;
    /** @type {string} */
    OwnerContactId;
    /** @type {string} */
    RecordStatus;
}
export class ProfileLicenseeRoleView {
    /** @param {{ApplianceId?:string,ApplianceName?:string,ProfileId?:string,ProfileName?:string,IsDefaultProfile?:boolean,ContactId?:string,ContactName?:string,ContactTypeId?:string,LicenseeContactRoleConnectionId?:string,UserContactRoleConnectionId?:string,RoleId?:string,RoleName?:string,LicenseeContactId?:string,LicenseeContactName?:string,RoleOrder?:number,ProfileImageUrl?:string,ProfileThumbnailImageUrl?:string,IsLicenseeRole?:boolean,IsManageContactsRole?:boolean,IsPlatformRole?:boolean,IsDefault?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ApplianceId;
    /** @type {string} */
    ApplianceName;
    /** @type {string} */
    ProfileId;
    /** @type {string} */
    ProfileName;
    /** @type {boolean} */
    IsDefaultProfile;
    /** @type {string} */
    ContactId;
    /** @type {string} */
    ContactName;
    /** @type {string} */
    ContactTypeId;
    /** @type {string} */
    LicenseeContactRoleConnectionId;
    /** @type {string} */
    UserContactRoleConnectionId;
    /** @type {string} */
    RoleId;
    /** @type {string} */
    RoleName;
    /** @type {string} */
    LicenseeContactId;
    /** @type {string} */
    LicenseeContactName;
    /** @type {number} */
    RoleOrder;
    /** @type {string} */
    ProfileImageUrl;
    /** @type {string} */
    ProfileThumbnailImageUrl;
    /** @type {boolean} */
    IsLicenseeRole;
    /** @type {boolean} */
    IsManageContactsRole;
    /** @type {boolean} */
    IsPlatformRole;
    /** @type {boolean} */
    IsDefault;
}
export class QuadrantModel {
    /** @param {{Appliances?:ListItemModel[],UserProfileId?:string,RoleConnectionId?:string,LicenseeContactId?:string,LicenseeContactName?:string,ApplianceId?:string,FullName?:string,ImpersonatingUserProfileId?:string,Connections?:ProfileLicenseeRoleView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ListItemModel[]} */
    Appliances;
    /** @type {string} */
    UserProfileId;
    /** @type {string} */
    RoleConnectionId;
    /** @type {string} */
    LicenseeContactId;
    /** @type {string} */
    LicenseeContactName;
    /** @type {string} */
    ApplianceId;
    /** @type {string} */
    FullName;
    /** @type {string} */
    ImpersonatingUserProfileId;
    /** @type {ProfileLicenseeRoleView[]} */
    Connections;
}
export class GetQuadrantResponse {
    /** @param {{Quadrant?:QuadrantModel,Permissions?:string[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {QuadrantModel} */
    Quadrant;
    /** @type {string[]} */
    Permissions;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetQuadrant {
    /** @param {{PerspectiveSessionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PerspectiveSessionId;
}

JavaScript GetQuadrant DTOs

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/quadrant HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Quadrant: 
	{
		Appliances: 
		[
			{
				Name: String,
				Description: String,
				ShortName: String,
				IsDefault: False,
				Order: 0,
				PrimaryListItemImageUrl: String,
				PrimaryImageThumbnailUrl: String,
				RecordStatus: String
			}
		],
		LicenseeContactName: String,
		FullName: String,
		Connections: 
		[
			{
				ApplianceName: String,
				ProfileName: String,
				IsDefaultProfile: False,
				ContactName: String,
				RoleName: String,
				LicenseeContactName: String,
				RoleOrder: 0,
				ProfileImageUrl: String,
				ProfileThumbnailImageUrl: String,
				IsLicenseeRole: False,
				IsManageContactsRole: False,
				IsPlatformRole: False,
				IsDefault: False
			}
		]
	},
	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
		}
	}
}