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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* 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")
open class GetQuadrant
{
    open var PerspectiveSessionId:UUID? = null
}

open class GetQuadrantResponse
{
    open var Quadrant:QuadrantModel? = null
    open var Permissions:ArrayList<UUID>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class QuadrantModel
{
    open var Appliances:ArrayList<ListItemModel>? = null
    open var UserProfileId:UUID? = null
    open var RoleConnectionId:UUID? = null
    open var LicenseeContactId:UUID? = null
    open var LicenseeContactName:String? = null
    open var ApplianceId:UUID? = null
    open var FullName:String? = null
    open var ImpersonatingUserProfileId:UUID? = null
    open var Connections:ArrayList<ProfileLicenseeRoleView>? = null
}

open class ListItemModel
{
    open var ListItemId:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var IsDefault:Boolean? = null
    open var Order:Int? = null
    open var ListItemTrafficLightId:UUID? = null
    open var PrimaryListItemImageId:UUID? = null
    open var PrimaryListItemImageUrl:String? = null
    open var PrimaryImageThumbnailUrl:String? = null
    open var OwnerContactId:UUID? = null
    open var RecordStatus:String? = null
}

open class ProfileLicenseeRoleView
{
    open var ApplianceId:UUID? = null
    open var ApplianceName:String? = null
    open var ProfileId:UUID? = null
    open var ProfileName:String? = null
    open var IsDefaultProfile:Boolean? = null
    open var ContactId:UUID? = null
    open var ContactName:String? = null
    open var ContactTypeId:UUID? = null
    open var LicenseeContactRoleConnectionId:UUID? = null
    open var UserContactRoleConnectionId:UUID? = null
    open var RoleId:UUID? = null
    open var RoleName:String? = null
    open var LicenseeContactId:UUID? = null
    open var LicenseeContactName:String? = null
    open var RoleOrder:Int? = null
    open var ProfileImageUrl:String? = null
    open var ProfileThumbnailImageUrl:String? = null
    open var IsLicenseeRole:Boolean? = null
    open var IsManageContactsRole:Boolean? = null
    open var IsPlatformRole:Boolean? = null
    open var IsDefault:Boolean? = null
}

Kotlin GetQuadrant DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"PerspectiveSessionId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}