| All Verbs | /api/quadrant | ||
|---|---|---|---|
| All Verbs | /api/core/quadrant |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PerspectiveSessionId | query | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Quadrant | form | QuadrantModel | No | |
| Permissions | form | List<Guid> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"PerspectiveSessionId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}