| All Verbs | /api/contactgroup/{ContactGroupId} |
|---|
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 UserProfileSummaryModel:
# @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
user_profile_id: Optional[str] = None
"""
User Profile Id
"""
# @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
user_id: Optional[str] = None
"""
User linked to the profile
"""
# @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
contact_id: Optional[str] = None
"""
Contact linked to the profile
"""
# @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
user_name: Optional[str] = None
"""
User linked to the profile
"""
# @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
profile_name: Optional[str] = None
"""
User Profile Name
"""
# @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
contact_full_name: Optional[str] = None
"""
Full name of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
email_address: Optional[str] = None
"""
Email Address of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
email_signature: Optional[str] = None
"""
Email signature of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
mobile_number: Optional[str] = None
"""
Mobile number of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
phone_number: Optional[str] = None
"""
Phone number of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
contact_type_id: Optional[str] = None
"""
Type of contact (person, organisation etc.) linked to the profile
"""
# @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")
contact_type_name: Optional[str] = None
"""
Type of contact (person, organisation etc.) linked to the profile
"""
# @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
first_name: Optional[str] = None
"""
First name of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
surname: Optional[str] = None
"""
Surname of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
title: Optional[str] = None
"""
Title of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
legal_name: Optional[str] = None
"""
Legal name of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
trading_name: Optional[str] = None
"""
Trading name of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
abn: Optional[str] = None
"""
Australian Business Number
"""
# @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
acn: Optional[str] = None
"""
Australian Company Number
"""
# @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
arbn: Optional[str] = None
"""
Australian Registered Body Number
"""
# @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
gst_registered: bool = False
"""
Indicates if the Contact is registered for GST.
"""
# @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
esl: bool = False
"""
True if english is a secondary language for the contact.
"""
# @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
language: Optional[str] = None
"""
Language that is the primary language for the contact.
"""
# @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
interpreter_required: bool = False
"""
True if an interpreter is required.
"""
# @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
licensee_notes: Optional[str] = None
"""
Licensee specific notes about the contact.
"""
# @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
profile_photo_url: Optional[str] = None
"""
Profile photo of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
profile_photo_thumbnail_url: Optional[str] = None
"""
Thumbnail photo of contact linked to the profile
"""
# @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
profile_image_id: Optional[str] = None
"""
Profile photo id of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Profile description", Name="Description")
description: Optional[str] = None
"""
Profile description
"""
# @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
employment_industry: Optional[str] = None
"""
Employment Industry
"""
# @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
employment_role: Optional[str] = None
"""
Employment Role
"""
# @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
employment_geographic_area: Optional[str] = None
"""
Areas of Work
"""
# @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
timezone: Optional[str] = None
"""
The contacts timezone.
"""
# @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
timezone_name: Optional[str] = None
"""
Timezone Name
"""
# @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
primary_address: Optional[str] = None
"""
The primary address of the contact
"""
# @ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
is_active_contact: bool = False
"""
Is this an active contact? Or an inactive contact (deleted account)?
"""
@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.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactGroupConnectionModel(UserProfileSummaryModel):
# @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
contact_group_id: Optional[str] = None
"""
Contact Group Id
"""
# @ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")
contact_group_connection_id: Optional[str] = None
"""
Connection id of the contact in the group
"""
# @ApiMember(DataType="string", Description="The Id of the Role this contact is connected to the group with.", Name="ConnectionRoleId")
connection_role_id: Optional[str] = None
"""
The Id of the Role this contact is connected to the group with.
"""
# @ApiMember(DataType="int", Description="Order of contacts within a group, the primary contact will have an index of 1.", Name="Index")
index: int = 0
"""
Order of contacts within a group, the primary contact will have an index of 1.
"""
# @ApiMember(DataType="string", Description="List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.", Name="ContactRoles")
contact_roles: Optional[List[RoleModel]] = None
"""
List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerProjectModel:
project_id: Optional[str] = None
name: Optional[str] = None
project_address: Optional[str] = None
manager_contact_id: Optional[str] = None
manager_contact_name: Optional[str] = None
manager_profile_photo_url: Optional[str] = None
manager_profile_photo_thumbnail_url: Optional[str] = None
supervisor_contact_id: Optional[str] = None
supervisor_contact_name: Optional[str] = None
supervisor_profile_photo_url: Optional[str] = None
supervisor_profile_photo_thumbnail_url: Optional[str] = None
customer_service_contact_id: Optional[str] = None
customer_service_contact_name: Optional[str] = None
customer_service_profile_photo_url: Optional[str] = None
customer_service_profile_photo_thumbnail: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactGroupModel:
# @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
contact_group_id: Optional[str] = None
"""
Contact Group Id
"""
# @ApiMember(DataType="string", Description="Contact Group Name", Name="Name")
name: Optional[str] = None
"""
Contact Group Name
"""
# @ApiMember(DataType="string", Description="Contact Group Reference", Name="Reference")
reference: Optional[str] = None
"""
Contact Group Reference
"""
# @ApiMember(DataType="Guid", Description="Group Role Id for e.g. Customer", Name="GroupRoleId")
group_role_id: Optional[str] = None
"""
Group Role Id for e.g. Customer
"""
# @ApiMember(DataType="string", Description="Primary contact in the group", Name="PrimaryContactName")
primary_contact_name: Optional[str] = None
"""
Primary contact in the group
"""
# @ApiMember(DataType="Guid", Description="Contact Id of the primary contact in the group", Name="PrimaryContactId")
primary_contact_id: Optional[str] = None
"""
Contact Id of the primary contact in the group
"""
# @ApiMember(DataType="string", Description="Profile photo url of the primary contact in the group", Name="PrimaryContactPhotoUrl")
primary_contact_photo_url: Optional[str] = None
"""
Profile photo url of the primary contact in the group
"""
# @ApiMember(DataType="string", Description="Profile photo thumbnail url of the primary contact in the group", Name="PrimaryContactThumbnailUrl")
primary_contact_thumbnail_url: Optional[str] = None
"""
Profile photo thumbnail url of the primary contact in the group
"""
# @ApiMember(DataType="int", Description="Number of contacts in the group", Name="NumberOfContacts")
number_of_contacts: int = 0
"""
Number of contacts in the group
"""
# @ApiMember(DataType="string", Description="Record Status of contact group", Name="RecordStatus")
record_status: Optional[str] = None
"""
Record Status of contact group
"""
# @ApiMember(DataType="List", Description="Details of contact in the contact group", Name="Contacts")
contacts: Optional[List[ContactGroupConnectionModel]] = None
"""
Details of contact in the contact group
"""
# @ApiMember(DataType="List", Description="Details of projects for the contact group", Name="Projects")
projects: Optional[List[CustomerProjectModel]] = None
"""
Details of projects for the contact group
"""
# @ApiResponse(Description="Get contact group and details of contacts in the contact group for e.g. contacts in a customer group and response status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactGroupResponse:
contact_group: Optional[ContactGroupModel] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get details of the specified contact group")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactGroup:
"""
Get details of the specified contact group
"""
# @ApiMember(Description="Get details of the specified contact group including details of contacts in the group", Name="ContactGroupId")
contact_group_id: Optional[str] = None
"""
Get details of the specified contact group including details of contacts in the group
"""
# @ApiMember(Description="The type of ContactGroup to get.", Name="ContactGroupRoleId")
contact_group_role_id: Optional[str] = None
"""
The type of ContactGroup to get.
"""
# @ApiMember(Description="Include projects linked to the contact group?", Name="IncludeProjects")
include_projects: bool = False
"""
Include projects linked to the contact group?
"""
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/contactgroup/{ContactGroupId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactGroupId>00000000-0000-0000-0000-000000000000</ContactGroupId>
<ContactGroupRoleId>00000000-0000-0000-0000-000000000000</ContactGroupRoleId>
<IncludeProjects>false</IncludeProjects>
</GetContactGroup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ContactGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupId>
<d2p1:Contacts>
<d2p1:ContactGroupConnectionModel>
<d2p1:Abn>String</d2p1:Abn>
<d2p1:Acn>String</d2p1:Acn>
<d2p1:Arbn>String</d2p1:Arbn>
<d2p1:ContactFullName>String</d2p1:ContactFullName>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
<d2p1:ContactTypeName>String</d2p1:ContactTypeName>
<d2p1:Description>String</d2p1:Description>
<d2p1:ESL>false</d2p1:ESL>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmailSignature>String</d2p1:EmailSignature>
<d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
<d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
<d2p1:EmploymentRole>String</d2p1:EmploymentRole>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:GstRegistered>false</d2p1:GstRegistered>
<d2p1:InterpreterRequired>false</d2p1:InterpreterRequired>
<d2p1:IsActiveContact>false</d2p1:IsActiveContact>
<d2p1:Language>String</d2p1:Language>
<d2p1:LegalName>String</d2p1:LegalName>
<d2p1:LicenseeNotes>String</d2p1:LicenseeNotes>
<d2p1:MobileNumber>String</d2p1:MobileNumber>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
<d2p1:ProfileImageId>00000000-0000-0000-0000-000000000000</d2p1:ProfileImageId>
<d2p1:ProfileName>String</d2p1:ProfileName>
<d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
<d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
<d2p1:Surname>String</d2p1:Surname>
<d2p1:Timezone>00000000-0000-0000-0000-000000000000</d2p1:Timezone>
<d2p1:TimezoneName>String</d2p1:TimezoneName>
<d2p1:Title>String</d2p1:Title>
<d2p1:TradingName>String</d2p1:TradingName>
<d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
<d2p1:UserName>String</d2p1:UserName>
<d2p1:UserProfileId>00000000-0000-0000-0000-000000000000</d2p1:UserProfileId>
<d2p1:ConnectionRoleId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionRoleId>
<d2p1:ContactGroupConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupConnectionId>
<d2p1:ContactGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupId>
<d2p1:ContactRoles>
<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>
</d2p1:ContactRoles>
<d2p1:Index>0</d2p1:Index>
</d2p1:ContactGroupConnectionModel>
</d2p1:Contacts>
<d2p1:GroupRoleId>00000000-0000-0000-0000-000000000000</d2p1:GroupRoleId>
<d2p1:Name>String</d2p1:Name>
<d2p1:NumberOfContacts>0</d2p1:NumberOfContacts>
<d2p1:PrimaryContactId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryContactId>
<d2p1:PrimaryContactName>String</d2p1:PrimaryContactName>
<d2p1:PrimaryContactPhotoUrl>String</d2p1:PrimaryContactPhotoUrl>
<d2p1:PrimaryContactThumbnailUrl>String</d2p1:PrimaryContactThumbnailUrl>
<d2p1:Projects>
<d2p1:CustomerProjectModel>
<d2p1:CustomerServiceContactId>00000000-0000-0000-0000-000000000000</d2p1:CustomerServiceContactId>
<d2p1:CustomerServiceContactName>String</d2p1:CustomerServiceContactName>
<d2p1:CustomerServiceProfilePhotoThumbnail>String</d2p1:CustomerServiceProfilePhotoThumbnail>
<d2p1:CustomerServiceProfilePhotoUrl>String</d2p1:CustomerServiceProfilePhotoUrl>
<d2p1:ManagerContactId>00000000-0000-0000-0000-000000000000</d2p1:ManagerContactId>
<d2p1:ManagerContactName>String</d2p1:ManagerContactName>
<d2p1:ManagerProfilePhotoThumbnailUrl>String</d2p1:ManagerProfilePhotoThumbnailUrl>
<d2p1:ManagerProfilePhotoUrl>String</d2p1:ManagerProfilePhotoUrl>
<d2p1:Name>String</d2p1:Name>
<d2p1:ProjectAddress>String</d2p1:ProjectAddress>
<d2p1:ProjectId>00000000-0000-0000-0000-000000000000</d2p1:ProjectId>
<d2p1:SupervisorContactId>00000000-0000-0000-0000-000000000000</d2p1:SupervisorContactId>
<d2p1:SupervisorContactName>String</d2p1:SupervisorContactName>
<d2p1:SupervisorProfilePhotoThumbnailUrl>String</d2p1:SupervisorProfilePhotoThumbnailUrl>
<d2p1:SupervisorProfilePhotoUrl>String</d2p1:SupervisorProfilePhotoUrl>
</d2p1:CustomerProjectModel>
</d2p1:Projects>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:Reference>String</d2p1:Reference>
</ContactGroup>
<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>
</GetContactGroupResponse>