Platform API

GetQuadrant

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

The following routes are available for this service:
All Verbs	/api/quadrant
All Verbs	/api/core/quadrant

**GetQuadrant** Parameters:
Name	Parameter	Data Type	Required	Description
PerspectiveSessionId	query	Guid	No

**GetQuadrantResponse** Parameters:
Name	Parameter	Data Type	Required
Quadrant	form	QuadrantModel	No
Permissions	form	List<Guid>	No
ResponseStatus	form	ResponseStatus	No

**QuadrantModel** Parameters:
Name	Parameter	Data Type	Required
Appliances	form	List<ListItemModel>	No
UserProfileId	form	Guid	No
RoleConnectionId	form	Guid	No
LicenseeContactId	form	Guid	No
LicenseeContactName	form	string	No
ApplianceId	form	Guid	No
FullName	form	string	No
ImpersonatingUserProfileId	form	Guid	No
Connections	form	List<ProfileLicenseeRoleView>	No

**ListItemModel** Parameters:
Name	Parameter	Data Type	Required
ListItemId	form	Guid	No
Name	form	string	No
Description	form	string	No
ShortName	form	string	No
IsDefault	form	bool	No
Order	form	int	No
ListItemTrafficLightId	form	Guid	No
PrimaryListItemImageId	form	Guid	No
PrimaryListItemImageUrl	form	string	No
PrimaryImageThumbnailUrl	form	string	No
OwnerContactId	form	Guid	No
RecordStatus	form	string	No

**ProfileLicenseeRoleView** Parameters:
Name	Parameter	Data Type	Required
ApplianceId	form	Guid	No
ApplianceName	form	string	No
ProfileId	form	Guid	No
ProfileName	form	string	No
IsDefaultProfile	form	bool	No
ContactId	form	Guid	No
ContactName	form	string	No
ContactTypeId	form	Guid	No
LicenseeContactRoleConnectionId	form	Guid	No
UserContactRoleConnectionId	form	Guid	No
RoleId	form	Guid	No
RoleName	form	string	No
LicenseeContactId	form	Guid	No
LicenseeContactName	form	string	No
RoleOrder	form	int	No
ProfileImageUrl	form	string	No
ProfileThumbnailImageUrl	form	string	No
IsLicenseeRole	form	bool	No
IsManageContactsRole	form	bool	No
IsPlatformRole	form	bool	No
IsDefault	form	bool	No

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