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
GetQuadrant Parameters:
NameParameterData TypeRequiredDescription
PerspectiveSessionIdqueryGuidNo
GetQuadrantResponse Parameters:
NameParameterData TypeRequiredDescription
QuadrantformQuadrantModelNo
PermissionsformList<Guid>No
ResponseStatusformResponseStatusNo
QuadrantModel Parameters:
NameParameterData TypeRequiredDescription
AppliancesformList<ListItemModel>No
UserProfileIdformGuidNo
RoleConnectionIdformGuidNo
LicenseeContactIdformGuidNo
LicenseeContactNameformstringNo
ApplianceIdformGuidNo
FullNameformstringNo
ImpersonatingUserProfileIdformGuidNo
ConnectionsformList<ProfileLicenseeRoleView>No
ListItemModel Parameters:
NameParameterData TypeRequiredDescription
ListItemIdformGuidNo
NameformstringNo
DescriptionformstringNo
ShortNameformstringNo
IsDefaultformboolNo
OrderformintNo
ListItemTrafficLightIdformGuidNo
PrimaryListItemImageIdformGuidNo
PrimaryListItemImageUrlformstringNo
PrimaryImageThumbnailUrlformstringNo
OwnerContactIdformGuidNo
RecordStatusformstringNo
ProfileLicenseeRoleView Parameters:
NameParameterData TypeRequiredDescription
ApplianceIdformGuidNo
ApplianceNameformstringNo
ProfileIdformGuidNo
ProfileNameformstringNo
IsDefaultProfileformboolNo
ContactIdformGuidNo
ContactNameformstringNo
ContactTypeIdformGuidNo
LicenseeContactRoleConnectionIdformGuidNo
UserContactRoleConnectionIdformGuidNo
RoleIdformGuidNo
RoleNameformstringNo
LicenseeContactIdformGuidNo
LicenseeContactNameformstringNo
RoleOrderformintNo
ProfileImageUrlformstringNo
ProfileThumbnailImageUrlformstringNo
IsLicenseeRoleformboolNo
IsManageContactsRoleformboolNo
IsPlatformRoleformboolNo
IsDefaultformboolNo

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

HTTP + OTHER

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

{"PerspectiveSessionId":"00000000-0000-0000-0000-000000000000"}

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

{"Quadrant":{"Appliances":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"UserProfileId":"00000000-0000-0000-0000-000000000000","RoleConnectionId":"00000000-0000-0000-0000-000000000000","LicenseeContactId":"00000000-0000-0000-0000-000000000000","LicenseeContactName":"String","ApplianceId":"00000000-0000-0000-0000-000000000000","FullName":"String","ImpersonatingUserProfileId":"00000000-0000-0000-0000-000000000000","Connections":[{"ApplianceId":"00000000-0000-0000-0000-000000000000","ApplianceName":"String","ProfileId":"00000000-0000-0000-0000-000000000000","ProfileName":"String","IsDefaultProfile":false,"ContactId":"00000000-0000-0000-0000-000000000000","ContactName":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","LicenseeContactRoleConnectionId":"00000000-0000-0000-0000-000000000000","UserContactRoleConnectionId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","LicenseeContactId":"00000000-0000-0000-0000-000000000000","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"}}}