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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models
Imports Eros.Saguna.Common.WebAPIModel.Models
Imports Eros.Causal.Common.Entity

Namespace Global

    Namespace Eros.Causal.Common.Entity

        Public Partial Class ProfileLicenseeRoleView
            Public Overridable Property ApplianceId As Guid
            Public Overridable Property ApplianceName As String
            Public Overridable Property ProfileId As Guid
            Public Overridable Property ProfileName As String
            Public Overridable Property IsDefaultProfile As Boolean
            Public Overridable Property ContactId As Guid
            Public Overridable Property ContactName As String
            Public Overridable Property ContactTypeId As Guid
            Public Overridable Property LicenseeContactRoleConnectionId As Guid
            Public Overridable Property UserContactRoleConnectionId As Guid
            Public Overridable Property RoleId As Guid
            Public Overridable Property RoleName As String
            Public Overridable Property LicenseeContactId As Guid
            Public Overridable Property LicenseeContactName As String
            Public Overridable Property RoleOrder As Integer
            Public Overridable Property ProfileImageUrl As String
            Public Overridable Property ProfileThumbnailImageUrl As String
            Public Overridable Property IsLicenseeRole As Boolean
            Public Overridable Property IsManageContactsRole As Boolean
            Public Overridable Property IsPlatformRole As Boolean
            Public Overridable Property IsDefault As Boolean
        End Class
    End Namespace

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        Public Partial Class ListItemModel
            Public Overridable Property ListItemId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property ShortName As String
            Public Overridable Property IsDefault As Boolean
            Public Overridable Property Order As Integer
            Public Overridable Property ListItemTrafficLightId As Guid
            Public Overridable Property PrimaryListItemImageId As Guid
            Public Overridable Property PrimaryListItemImageUrl As String
            Public Overridable Property PrimaryImageThumbnailUrl As String
            Public Overridable Property OwnerContactId As Guid
            Public Overridable Property RecordStatus As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class QuadrantModel
            Public Overridable Property Appliances As List(Of ListItemModel)
            Public Overridable Property UserProfileId As Guid
            Public Overridable Property RoleConnectionId As Guid
            Public Overridable Property LicenseeContactId As Guid
            Public Overridable Property LicenseeContactName As String
            Public Overridable Property ApplianceId As Guid
            Public Overridable Property FullName As String
            Public Overridable Property ImpersonatingUserProfileId As Guid
            Public Overridable Property Connections As List(Of ProfileLicenseeRoleView)
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get quadrant data for the perspective session id specified in the authentication token
        '''</Summary>
        <Api(Description:="Get quadrant data for the perspective session id specified in the authentication token")>
        Public Partial Class GetQuadrant
            Public Overridable Property PerspectiveSessionId As Guid
        End Class

        Public Partial Class GetQuadrantResponse
            Public Overridable Property Quadrant As QuadrantModel
            Public Overridable Property Permissions As List(Of Guid)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}