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

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ListItemModel() = 
        member val ListItemId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val ShortName:String = null with get,set
        member val IsDefault:Boolean = new Boolean() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val ListItemTrafficLightId:Guid = new Guid() with get,set
        member val PrimaryListItemImageId:Guid = new Guid() with get,set
        member val PrimaryListItemImageUrl:String = null with get,set
        member val PrimaryImageThumbnailUrl:String = null with get,set
        member val OwnerContactId:Guid = new Guid() with get,set
        member val RecordStatus:String = null with get,set

    [<AllowNullLiteral>]
    type ProfileLicenseeRoleView() = 
        member val ApplianceId:Guid = new Guid() with get,set
        member val ApplianceName:String = null with get,set
        member val ProfileId:Guid = new Guid() with get,set
        member val ProfileName:String = null with get,set
        member val IsDefaultProfile:Boolean = new Boolean() with get,set
        member val ContactId:Guid = new Guid() with get,set
        member val ContactName:String = null with get,set
        member val ContactTypeId:Guid = new Guid() with get,set
        member val LicenseeContactRoleConnectionId:Guid = new Guid() with get,set
        member val UserContactRoleConnectionId:Guid = new Guid() with get,set
        member val RoleId:Guid = new Guid() with get,set
        member val RoleName:String = null with get,set
        member val LicenseeContactId:Guid = new Guid() with get,set
        member val LicenseeContactName:String = null with get,set
        member val RoleOrder:Int32 = new Int32() with get,set
        member val ProfileImageUrl:String = null with get,set
        member val ProfileThumbnailImageUrl:String = null with get,set
        member val IsLicenseeRole:Boolean = new Boolean() with get,set
        member val IsManageContactsRole:Boolean = new Boolean() with get,set
        member val IsPlatformRole:Boolean = new Boolean() with get,set
        member val IsDefault:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type QuadrantModel() = 
        member val Appliances:ResizeArray<ListItemModel> = null with get,set
        member val UserProfileId:Guid = new Guid() with get,set
        member val RoleConnectionId:Guid = new Guid() with get,set
        member val LicenseeContactId:Guid = new Guid() with get,set
        member val LicenseeContactName:String = null with get,set
        member val ApplianceId:Guid = new Guid() with get,set
        member val FullName:String = null with get,set
        member val ImpersonatingUserProfileId:Guid = new Guid() with get,set
        member val Connections:ResizeArray<ProfileLicenseeRoleView> = null with get,set

    [<AllowNullLiteral>]
    type GetQuadrantResponse() = 
        member val Quadrant:QuadrantModel = null with get,set
        member val Permissions:ResizeArray<Guid> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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")>]
    [<AllowNullLiteral>]
    type GetQuadrant() = 
        member val PerspectiveSessionId:Guid = new Guid() with get,set

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