| All Verbs | /api/roles/{ContactId} | ||
|---|---|---|---|
| All Verbs | /api/resourceroles/available/{ContactId} | ||
| All Verbs | /api/resourceroles/licensee/{RoleListItemFilterId} | ||
| All Verbs | /api/resourceroles/licensee | ||
| All Verbs | /api/licenseeroles/{ContactId} |
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 RoleModel:
# @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
role_id: Optional[str] = None
"""
Role Id
"""
# @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
role_name: Optional[str] = None
"""
Role Name
"""
# @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
is_licensee_role: bool = False
"""
Is the role a licensee role?
"""
# @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
is_manage_contacts: bool = False
"""
Is manage contacts role?
"""
# @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
is_platform_role: bool = False
"""
Is the role a Platform role?
"""
# @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
is_service_role: bool = False
"""
Is the role a services role?
"""
# @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
is_customer_role: bool = False
"""
Is the role a customer role?
"""
# @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
is_functional_role: bool = False
"""
Is the role a functional role?
"""
# @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
is_request_auto_accepted: bool = False
"""
Is the role an auto-accept role?
"""
# @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
suite_id: Optional[str] = None
"""
Suite that the role belongs to
"""
# @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
suite_name: Optional[str] = None
"""
Suite that the role belongs to
"""
# @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
record_status: Optional[str] = None
"""
'A' (Active) or 'I' (Inactive)
"""
# @ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
object_connection_id: Optional[str] = None
"""
Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
"""
# @ApiResponse(Description="List of roles")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRolesResponse:
roles: Optional[List[RoleModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get roles for the specified contact")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRolesForContact:
"""
Get roles for the specified contact
"""
# @ApiMember(Description="Get roles (custom and standard roles) for the specified contact", IsRequired=true, Name="ContactId")
contact_id: Optional[str] = None
"""
Get roles (custom and standard roles) for the specified contact
"""
# @ApiMember(Description="List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}", IsRequired=true, Name="RoleListItemFilterId")
role_list_item_filter_id: Optional[str] = None
"""
List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}
"""
Python GetRolesForContact DTOs
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/roles/{ContactId} 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
{
Roles:
[
{
RoleName: String,
IsLicenseeRole: False,
IsManageContacts: False,
IsPlatformRole: False,
IsServiceRole: False,
IsCustomerRole: False,
IsFunctionalRole: False,
IsRequestAutoAccepted: False,
SuiteName: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}