| All Verbs | /api/quadrant | ||
|---|---|---|---|
| All Verbs | /api/core/quadrant |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListItemModel:
list_item_id: Optional[str] = None
name: Optional[str] = None
description: Optional[str] = None
short_name: Optional[str] = None
is_default: bool = False
order: int = 0
list_item_traffic_light_id: Optional[str] = None
primary_list_item_image_id: Optional[str] = None
primary_list_item_image_url: Optional[str] = None
primary_image_thumbnail_url: Optional[str] = None
owner_contact_id: Optional[str] = None
record_status: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileLicenseeRoleView:
appliance_id: Optional[str] = None
appliance_name: Optional[str] = None
profile_id: Optional[str] = None
profile_name: Optional[str] = None
is_default_profile: bool = False
contact_id: Optional[str] = None
contact_name: Optional[str] = None
contact_type_id: Optional[str] = None
licensee_contact_role_connection_id: Optional[str] = None
user_contact_role_connection_id: Optional[str] = None
role_id: Optional[str] = None
role_name: Optional[str] = None
licensee_contact_id: Optional[str] = None
licensee_contact_name: Optional[str] = None
role_order: int = 0
profile_image_url: Optional[str] = None
profile_thumbnail_image_url: Optional[str] = None
is_licensee_role: bool = False
is_manage_contacts_role: bool = False
is_platform_role: bool = False
is_default: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuadrantModel:
appliances: Optional[List[ListItemModel]] = None
user_profile_id: Optional[str] = None
role_connection_id: Optional[str] = None
licensee_contact_id: Optional[str] = None
licensee_contact_name: Optional[str] = None
appliance_id: Optional[str] = None
full_name: Optional[str] = None
impersonating_user_profile_id: Optional[str] = None
connections: Optional[List[ProfileLicenseeRoleView]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetQuadrantResponse:
quadrant: Optional[QuadrantModel] = None
permissions: Optional[List[str]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get quadrant data for the perspective session id specified in the authentication token")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetQuadrant:
"""
Get quadrant data for the perspective session id specified in the authentication token
"""
perspective_session_id: Optional[str] = None
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
}
}
}