| All Verbs | /api/quadrant | ||
|---|---|---|---|
| All Verbs | /api/core/quadrant |
import Foundation
import ServiceStack
/**
* 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")
public class GetQuadrant : Codable
{
public var perspectiveSessionId:String
required public init(){}
}
public class GetQuadrantResponse : Codable
{
public var quadrant:QuadrantModel
public var permissions:[String]
public var responseStatus:ResponseStatus
required public init(){}
}
public class QuadrantModel : Codable
{
public var appliances:[ListItemModel]
public var userProfileId:String
public var roleConnectionId:String
public var licenseeContactId:String
public var licenseeContactName:String
public var applianceId:String
public var fullName:String
public var impersonatingUserProfileId:String
public var connections:[ProfileLicenseeRoleView]
required public init(){}
}
public class ListItemModel : Codable
{
public var listItemId:String
public var name:String
public var Description:String
public var shortName:String
public var isDefault:Bool
public var order:Int
public var listItemTrafficLightId:String
public var primaryListItemImageId:String
public var primaryListItemImageUrl:String
public var primaryImageThumbnailUrl:String
public var ownerContactId:String
public var recordStatus:String
required public init(){}
}
public class ProfileLicenseeRoleView : Codable
{
public var applianceId:String
public var applianceName:String
public var profileId:String
public var profileName:String
public var isDefaultProfile:Bool
public var contactId:String
public var contactName:String
public var contactTypeId:String
public var licenseeContactRoleConnectionId:String
public var userContactRoleConnectionId:String
public var roleId:String
public var roleName:String
public var licenseeContactId:String
public var licenseeContactName:String
public var roleOrder:Int
public var profileImageUrl:String
public var profileThumbnailImageUrl:String
public var isLicenseeRole:Bool
public var isManageContactsRole:Bool
public var isPlatformRole:Bool
public var isDefault:Bool
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}