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 .xml suffix or ?format=xml

HTTP + XML

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

<GetQuadrant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <PerspectiveSessionId>00000000-0000-0000-0000-000000000000</PerspectiveSessionId>
</GetQuadrant>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetQuadrantResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Permissions>
  <Quadrant xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:ApplianceId>00000000-0000-0000-0000-000000000000</d2p1:ApplianceId>
    <d2p1:Appliances xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
      <d3p1:ListItemModel>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:IsDefault>false</d3p1:IsDefault>
        <d3p1:ListItemId>00000000-0000-0000-0000-000000000000</d3p1:ListItemId>
        <d3p1:ListItemTrafficLightId>00000000-0000-0000-0000-000000000000</d3p1:ListItemTrafficLightId>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:Order>0</d3p1:Order>
        <d3p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d3p1:OwnerContactId>
        <d3p1:PrimaryImageThumbnailUrl>String</d3p1:PrimaryImageThumbnailUrl>
        <d3p1:PrimaryListItemImageId>00000000-0000-0000-0000-000000000000</d3p1:PrimaryListItemImageId>
        <d3p1:PrimaryListItemImageUrl>String</d3p1:PrimaryListItemImageUrl>
        <d3p1:RecordStatus>String</d3p1:RecordStatus>
        <d3p1:ShortName>String</d3p1:ShortName>
      </d3p1:ListItemModel>
    </d2p1:Appliances>
    <d2p1:Connections xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
      <d3p1:ProfileLicenseeRoleView>
        <d3p1:_x003C_ApplianceId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_ApplianceId_x003E_k__BackingField>
        <d3p1:_x003C_ApplianceName_x003E_k__BackingField>String</d3p1:_x003C_ApplianceName_x003E_k__BackingField>
        <d3p1:_x003C_ContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_ContactId_x003E_k__BackingField>
        <d3p1:_x003C_ContactName_x003E_k__BackingField>String</d3p1:_x003C_ContactName_x003E_k__BackingField>
        <d3p1:_x003C_ContactTypeId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_ContactTypeId_x003E_k__BackingField>
        <d3p1:_x003C_IsDefaultProfile_x003E_k__BackingField>false</d3p1:_x003C_IsDefaultProfile_x003E_k__BackingField>
        <d3p1:_x003C_IsDefault_x003E_k__BackingField>false</d3p1:_x003C_IsDefault_x003E_k__BackingField>
        <d3p1:_x003C_IsLicenseeRole_x003E_k__BackingField>false</d3p1:_x003C_IsLicenseeRole_x003E_k__BackingField>
        <d3p1:_x003C_IsManageContactsRole_x003E_k__BackingField>false</d3p1:_x003C_IsManageContactsRole_x003E_k__BackingField>
        <d3p1:_x003C_IsPlatformRole_x003E_k__BackingField>false</d3p1:_x003C_IsPlatformRole_x003E_k__BackingField>
        <d3p1:_x003C_LicenseeContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_LicenseeContactId_x003E_k__BackingField>
        <d3p1:_x003C_LicenseeContactName_x003E_k__BackingField>String</d3p1:_x003C_LicenseeContactName_x003E_k__BackingField>
        <d3p1:_x003C_LicenseeContactRoleConnectionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_LicenseeContactRoleConnectionId_x003E_k__BackingField>
        <d3p1:_x003C_ProfileId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_ProfileId_x003E_k__BackingField>
        <d3p1:_x003C_ProfileImageUrl_x003E_k__BackingField>String</d3p1:_x003C_ProfileImageUrl_x003E_k__BackingField>
        <d3p1:_x003C_ProfileName_x003E_k__BackingField>String</d3p1:_x003C_ProfileName_x003E_k__BackingField>
        <d3p1:_x003C_ProfileThumbnailImageUrl_x003E_k__BackingField>String</d3p1:_x003C_ProfileThumbnailImageUrl_x003E_k__BackingField>
        <d3p1:_x003C_RoleId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_RoleId_x003E_k__BackingField>
        <d3p1:_x003C_RoleName_x003E_k__BackingField>String</d3p1:_x003C_RoleName_x003E_k__BackingField>
        <d3p1:_x003C_RoleOrder_x003E_k__BackingField>0</d3p1:_x003C_RoleOrder_x003E_k__BackingField>
        <d3p1:_x003C_UserContactRoleConnectionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_UserContactRoleConnectionId_x003E_k__BackingField>
      </d3p1:ProfileLicenseeRoleView>
    </d2p1:Connections>
    <d2p1:FullName>String</d2p1:FullName>
    <d2p1:ImpersonatingUserProfileId>00000000-0000-0000-0000-000000000000</d2p1:ImpersonatingUserProfileId>
    <d2p1:LicenseeContactId>00000000-0000-0000-0000-000000000000</d2p1:LicenseeContactId>
    <d2p1:LicenseeContactName>String</d2p1:LicenseeContactName>
    <d2p1:RoleConnectionId>00000000-0000-0000-0000-000000000000</d2p1:RoleConnectionId>
    <d2p1:UserProfileId>00000000-0000-0000-0000-000000000000</d2p1:UserProfileId>
  </Quadrant>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetQuadrantResponse>