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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Subtle.Canvara.WebAPIModel.Models;
using Eros.Saguna.Common.WebAPIModel.Models;
using Eros.Causal.Common.Entity;

namespace Eros.Causal.Common.Entity
{
    public partial class ProfileLicenseeRoleView
    {
        public virtual Guid ApplianceId { get; set; }
        public virtual string ApplianceName { get; set; }
        public virtual Guid ProfileId { get; set; }
        public virtual string ProfileName { get; set; }
        public virtual bool IsDefaultProfile { get; set; }
        public virtual Guid ContactId { get; set; }
        public virtual string ContactName { get; set; }
        public virtual Guid ContactTypeId { get; set; }
        public virtual Guid LicenseeContactRoleConnectionId { get; set; }
        public virtual Guid UserContactRoleConnectionId { get; set; }
        public virtual Guid RoleId { get; set; }
        public virtual string RoleName { get; set; }
        public virtual Guid LicenseeContactId { get; set; }
        public virtual string LicenseeContactName { get; set; }
        public virtual int RoleOrder { get; set; }
        public virtual string ProfileImageUrl { get; set; }
        public virtual string ProfileThumbnailImageUrl { get; set; }
        public virtual bool IsLicenseeRole { get; set; }
        public virtual bool IsManageContactsRole { get; set; }
        public virtual bool IsPlatformRole { get; set; }
        public virtual bool IsDefault { get; set; }
    }

}

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class ListItemModel
    {
        public virtual Guid ListItemId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string ShortName { get; set; }
        public virtual bool IsDefault { get; set; }
        public virtual int Order { get; set; }
        public virtual Guid ListItemTrafficLightId { get; set; }
        public virtual Guid PrimaryListItemImageId { get; set; }
        public virtual string PrimaryListItemImageUrl { get; set; }
        public virtual string PrimaryImageThumbnailUrl { get; set; }
        public virtual Guid OwnerContactId { get; set; }
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.Models
{
    public partial class QuadrantModel
    {
        public virtual List<ListItemModel> Appliances { get; set; }
        public virtual Guid UserProfileId { get; set; }
        public virtual Guid RoleConnectionId { get; set; }
        public virtual Guid LicenseeContactId { get; set; }
        public virtual string LicenseeContactName { get; set; }
        public virtual Guid ApplianceId { get; set; }
        public virtual string FullName { get; set; }
        public virtual Guid ImpersonatingUserProfileId { get; set; }
        public virtual List<ProfileLicenseeRoleView> Connections { get; set; }
    }

}

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 virtual Guid PerspectiveSessionId { get; set; }
    }

    public partial class GetQuadrantResponse
    {
        public virtual QuadrantModel Quadrant { get; set; }
        public virtual List<Guid> Permissions { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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