Platform API

<back to all web services

GetObjectContactConnections

Get contact connections for the specified object.

Requires Authentication
The following routes are available for this service:
GET/api/objects/{ObjectId}/contactconnections
GET/api/projects/{ObjectId}/myteam
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get contact connections for the specified object.
*/
@Api(Description="Get contact connections for the specified object.")
open class GetObjectContactConnections
{
    /**
    * Object Id to get contact connections for
    */
    @ApiMember(DataType="Guid", Description="Object Id to get contact connections for", IsRequired=true, Name="ObjectId")
    open var ObjectId:UUID? = null
}

@ApiResponse(Description="Returns the contact connections for the specified object.")
open class GetObjectContactConnectionsResponse
{
    open var ContactConnections:ArrayList<ObjectContactConnectionModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class ObjectContactConnectionModel
{
    open var ObjectContactConnectionId:UUID? = null
    open var ContactRoleConnectionId:UUID? = null
    open var ObjectId:UUID? = null
    open var Contact:ContactSummaryModel? = null
    open var RoleId:UUID? = null
    open var RoleName:String? = null
    open var Created:Date? = null
}

open class ContactSummaryModel
{
    /**
    * Contact linked to the profile
    */
    @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * Full name of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
    open var ContactFullName:String? = null

    /**
    * Email Address of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
    open var EmailAddress:String? = null

    /**
    * Mobile Number of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")
    open var MobileNumber:String? = null

    /**
    * Primary Phone Number of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
    open var PhoneNumber:String? = null

    /**
    * 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="ContactTypeId")
    open var ContactTypeId:UUID? = null

    /**
    * Profile photo of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    open var ProfilePhotoUrl:String? = null

    /**
    * Thumbnail photo of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    open var ProfilePhotoThumbnailUrl:String? = null

    /**
    * Profile description
    */
    @ApiMember(DataType="string", Description="Profile description", Name="Description")
    open var Description:String? = null

    /**
    * Employment Industry
    */
    @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    open var EmploymentIndustry:String? = null

    /**
    * Employment Role
    */
    @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    open var EmploymentRole:String? = null

    /**
    * Areas of Work
    */
    @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    open var EmploymentGeographicArea:String? = null

    /**
    * Timezone Name
    */
    @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    open var TimezoneName:String? = null

    /**
    * The primary address of the contact
    */
    @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    open var PrimaryAddress:String? = null

    /**
    * Have all connections to the contact been removed?
    */
    @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
    open var IsRemovedContact:Boolean? = null
}

Kotlin GetObjectContactConnections DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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>