| All Verbs | /api/roles/{RoleId}/associatedroles/safetystaff | ||
|---|---|---|---|
| All Verbs | /api/roles/{RoleId}/associatedroles/organisation |
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 associated roles by contact type")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAssociatedRolesForRoleResponse:
roles: Optional[List[RoleModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get associated roles for a specified role")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAssociatedRolesForRole:
"""
Get associated roles for a specified role
"""
# @ApiMember(DataType="Guid", Description="The Role Guid. Records retrieved will belong to this role.", IsRequired=true, Name="RoleId", ParameterType="query")
role_id: Optional[str] = None
"""
The Role Guid. Records retrieved will belong to this role.
"""
Python GetAssociatedRolesForRole DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/roles/{RoleId}/associatedroles/safetystaff HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAssociatedRolesForRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<RoleId>00000000-0000-0000-0000-000000000000</RoleId>
</GetAssociatedRolesForRole>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetAssociatedRolesForRoleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Roles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:RoleModel>
<d2p1:IsCustomerRole>false</d2p1:IsCustomerRole>
<d2p1:IsFunctionalRole>false</d2p1:IsFunctionalRole>
<d2p1:IsLicenseeRole>false</d2p1:IsLicenseeRole>
<d2p1:IsManageContacts>false</d2p1:IsManageContacts>
<d2p1:IsPlatformRole>false</d2p1:IsPlatformRole>
<d2p1:IsRequestAutoAccepted>false</d2p1:IsRequestAutoAccepted>
<d2p1:IsServiceRole>false</d2p1:IsServiceRole>
<d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
</d2p1:RoleModel>
</Roles>
</GetAssociatedRolesForRoleResponse>