Platform API

<back to all web services

GetObjectContactConnections

Get contact connections for the specified object.

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 ContactSummaryModel:
    # @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="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="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="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
    phone_number: Optional[str] = None
    """
    Primary 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="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="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="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="Have all connections to the contact been removed?", Name="IsRemovedContact")
    is_removed_contact: bool = False
    """
    Have all connections to the contact been removed?
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObjectContactConnectionModel:
    object_contact_connection_id: Optional[str] = None
    contact_role_connection_id: Optional[str] = None
    object_id: Optional[str] = None
    contact: Optional[ContactSummaryModel] = None
    role_id: Optional[str] = None
    role_name: Optional[str] = None
    created: datetime.datetime = datetime.datetime(1, 1, 1)


# @ApiResponse(Description="Returns the contact connections for the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectContactConnectionsResponse:
    contact_connections: Optional[List[ObjectContactConnectionModel]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get contact connections for the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectContactConnections:
    """
    Get contact connections for the specified object.
    """

    # @ApiMember(DataType="Guid", Description="Object Id to get contact connections for", IsRequired=true, Name="ObjectId")
    object_id: Optional[str] = None
    """
    Object Id to get contact connections for
    """

Python GetObjectContactConnections DTOs

GET /api/objects/{ObjectId}/contactconnections HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjectContactConnectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ContactConnections xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ObjectContactConnectionModel>
      <d2p1:Contact>
        <d2p1:ContactFullName>String</d2p1:ContactFullName>
        <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
        <d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:EmailAddress>String</d2p1:EmailAddress>
        <d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
        <d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
        <d2p1:EmploymentRole>String</d2p1:EmploymentRole>
        <d2p1:IsRemovedContact>false</d2p1:IsRemovedContact>
        <d2p1:MobileNumber>String</d2p1:MobileNumber>
        <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
        <d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
        <d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
        <d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
        <d2p1:TimezoneName>String</d2p1:TimezoneName>
      </d2p1:Contact>
      <d2p1:ContactRoleConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleConnectionId>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:ObjectContactConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectContactConnectionId>
      <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
      <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
      <d2p1:RoleName>String</d2p1:RoleName>
    </d2p1:ObjectContactConnectionModel>
  </ContactConnections>
  <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>
</GetObjectContactConnectionsResponse>