| All Verbs | /api/contactroles/{LicenseeId} |
|---|
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 contact roles (custom and/or standard) for the specified licensee")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactRolesForLicenseeResponse:
roles: Optional[List[RoleModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get contact roles (custom and/or standard) for the specified licensee")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactRolesForLicensee:
"""
Get contact roles (custom and/or standard) for the specified licensee
"""
# @ApiMember(DataType="Guid", Description="Get contact roles (custom and/or standard) for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
licensee_id: Optional[str] = None
"""
Get contact roles (custom and/or standard) for the specified licensee
"""
# @ApiMember(DataType="List<Guid>", Description="Contact Types", Name="ContactTypes", ParameterType="query")
contact_types: Optional[List[str]] = None
"""
Contact Types
"""
# @ApiMember(DataType="List<Guid>", Description="Custom/Standard filter", Name="OwnerFilterIds", ParameterType="query")
owner_filter_ids: Optional[List[str]] = None
"""
Custom/Standard filter
"""
# @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
record_status: Optional[str] = None
"""
Active/Archived filter
"""
# @ApiMember(DataType="string", Description="Text filter", Name="SearchText", ParameterType="query")
search_text: Optional[str] = None
"""
Text filter
"""
Python GetContactRolesForLicensee DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contactroles/{LicenseeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"OwnerFilterIds":["00000000-0000-0000-0000-000000000000"],"RecordStatus":"String","SearchText":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","IsLicenseeRole":false,"IsManageContacts":false,"IsPlatformRole":false,"IsServiceRole":false,"IsCustomerRole":false,"IsFunctionalRole":false,"IsRequestAutoAccepted":false,"SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","RecordStatus":"String","ObjectConnectionId":"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"}}}