Platform API

<back to all web services

GetQuadrant

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

export class ListItemModel
{
    public ListItemId: string;
    public Name: string;
    public Description: string;
    public ShortName: string;
    public IsDefault: boolean;
    public Order: number;
    public ListItemTrafficLightId: string;
    public PrimaryListItemImageId: string;
    public PrimaryListItemImageUrl: string;
    public PrimaryImageThumbnailUrl: string;
    public OwnerContactId: string;
    public RecordStatus: string;

    public constructor(init?: Partial<ListItemModel>) { (Object as any).assign(this, init); }
}

export class ProfileLicenseeRoleView
{
    public ApplianceId: string;
    public ApplianceName: string;
    public ProfileId: string;
    public ProfileName: string;
    public IsDefaultProfile: boolean;
    public ContactId: string;
    public ContactName: string;
    public ContactTypeId: string;
    public LicenseeContactRoleConnectionId: string;
    public UserContactRoleConnectionId: string;
    public RoleId: string;
    public RoleName: string;
    public LicenseeContactId: string;
    public LicenseeContactName: string;
    public RoleOrder: number;
    public ProfileImageUrl: string;
    public ProfileThumbnailImageUrl: string;
    public IsLicenseeRole: boolean;
    public IsManageContactsRole: boolean;
    public IsPlatformRole: boolean;
    public IsDefault: boolean;

    public constructor(init?: Partial<ProfileLicenseeRoleView>) { (Object as any).assign(this, init); }
}

export class QuadrantModel
{
    public Appliances: ListItemModel[];
    public UserProfileId: string;
    public RoleConnectionId: string;
    public LicenseeContactId: string;
    public LicenseeContactName: string;
    public ApplianceId: string;
    public FullName: string;
    public ImpersonatingUserProfileId: string;
    public Connections: ProfileLicenseeRoleView[];

    public constructor(init?: Partial<QuadrantModel>) { (Object as any).assign(this, init); }
}

export class GetQuadrantResponse
{
    public Quadrant: QuadrantModel;
    public Permissions: string[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetQuadrantResponse>) { (Object as any).assign(this, init); }
}

/** @description Get quadrant data for the perspective session id specified in the authentication token */
// @Api(Description="Get quadrant data for the perspective session id specified in the authentication token")
export class GetQuadrant
{
    public PerspectiveSessionId: string;

    public constructor(init?: Partial<GetQuadrant>) { (Object as any).assign(this, init); }
}

TypeScript GetQuadrant DTOs

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