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.*;

public class dtos
{

    /**
    * Get contact connections for the specified object.
    */
    @Api(Description="Get contact connections for the specified object.")
    public static class GetObjectContactConnections
    {
        /**
        * Object Id to get contact connections for
        */
        @ApiMember(DataType="Guid", Description="Object Id to get contact connections for", IsRequired=true, Name="ObjectId")
        public UUID ObjectId = null;
        
        public UUID getObjectId() { return ObjectId; }
        public GetObjectContactConnections setObjectId(UUID value) { this.ObjectId = value; return this; }
    }

    @ApiResponse(Description="Returns the contact connections for the specified object.")
    public static class GetObjectContactConnectionsResponse
    {
        public ArrayList<ObjectContactConnectionModel> ContactConnections = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ObjectContactConnectionModel> getContactConnections() { return ContactConnections; }
        public GetObjectContactConnectionsResponse setContactConnections(ArrayList<ObjectContactConnectionModel> value) { this.ContactConnections = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetObjectContactConnectionsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ObjectContactConnectionModel
    {
        public UUID ObjectContactConnectionId = null;
        public UUID ContactRoleConnectionId = null;
        public UUID ObjectId = null;
        public ContactSummaryModel Contact = null;
        public UUID RoleId = null;
        public String RoleName = null;
        public Date Created = null;
        
        public UUID getObjectContactConnectionId() { return ObjectContactConnectionId; }
        public ObjectContactConnectionModel setObjectContactConnectionId(UUID value) { this.ObjectContactConnectionId = value; return this; }
        public UUID getContactRoleConnectionId() { return ContactRoleConnectionId; }
        public ObjectContactConnectionModel setContactRoleConnectionId(UUID value) { this.ContactRoleConnectionId = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public ObjectContactConnectionModel setObjectId(UUID value) { this.ObjectId = value; return this; }
        public ContactSummaryModel getContact() { return Contact; }
        public ObjectContactConnectionModel setContact(ContactSummaryModel value) { this.Contact = value; return this; }
        public UUID getRoleId() { return RoleId; }
        public ObjectContactConnectionModel setRoleId(UUID value) { this.RoleId = value; return this; }
        public String getRoleName() { return RoleName; }
        public ObjectContactConnectionModel setRoleName(String value) { this.RoleName = value; return this; }
        public Date getCreated() { return Created; }
        public ObjectContactConnectionModel setCreated(Date value) { this.Created = value; return this; }
    }

    public static class ContactSummaryModel
    {
        /**
        * Contact linked to the profile
        */
        @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
        public UUID ContactId = 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")
        public String ContactFullName = 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")
        public String EmailAddress = 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")
        public String MobileNumber = 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")
        public String PhoneNumber = 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")
        public UUID ContactTypeId = null;

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

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

        /**
        * Profile description
        */
        @ApiMember(DataType="string", Description="Profile description", Name="Description")
        public String Description = null;

        /**
        * Employment Industry
        */
        @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
        public String EmploymentIndustry = null;

        /**
        * Employment Role
        */
        @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
        public String EmploymentRole = null;

        /**
        * Areas of Work
        */
        @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
        public String EmploymentGeographicArea = null;

        /**
        * Timezone Name
        */
        @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
        public String TimezoneName = null;

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

        /**
        * Have all connections to the contact been removed?
        */
        @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
        public Boolean IsRemovedContact = null;
        
        public UUID getContactId() { return ContactId; }
        public ContactSummaryModel setContactId(UUID value) { this.ContactId = value; return this; }
        public String getContactFullName() { return ContactFullName; }
        public ContactSummaryModel setContactFullName(String value) { this.ContactFullName = value; return this; }
        public String getEmailAddress() { return EmailAddress; }
        public ContactSummaryModel setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public String getMobileNumber() { return MobileNumber; }
        public ContactSummaryModel setMobileNumber(String value) { this.MobileNumber = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public ContactSummaryModel setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public UUID getContactTypeId() { return ContactTypeId; }
        public ContactSummaryModel setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
        public String getProfilePhotoUrl() { return ProfilePhotoUrl; }
        public ContactSummaryModel setProfilePhotoUrl(String value) { this.ProfilePhotoUrl = value; return this; }
        public String getProfilePhotoThumbnailUrl() { return ProfilePhotoThumbnailUrl; }
        public ContactSummaryModel setProfilePhotoThumbnailUrl(String value) { this.ProfilePhotoThumbnailUrl = value; return this; }
        public String getDescription() { return Description; }
        public ContactSummaryModel setDescription(String value) { this.Description = value; return this; }
        public String getEmploymentIndustry() { return EmploymentIndustry; }
        public ContactSummaryModel setEmploymentIndustry(String value) { this.EmploymentIndustry = value; return this; }
        public String getEmploymentRole() { return EmploymentRole; }
        public ContactSummaryModel setEmploymentRole(String value) { this.EmploymentRole = value; return this; }
        public String getEmploymentGeographicArea() { return EmploymentGeographicArea; }
        public ContactSummaryModel setEmploymentGeographicArea(String value) { this.EmploymentGeographicArea = value; return this; }
        public String getTimezoneName() { return TimezoneName; }
        public ContactSummaryModel setTimezoneName(String value) { this.TimezoneName = value; return this; }
        public String getPrimaryAddress() { return PrimaryAddress; }
        public ContactSummaryModel setPrimaryAddress(String value) { this.PrimaryAddress = value; return this; }
        public Boolean getIsRemovedContact() { return IsRemovedContact; }
        public ContactSummaryModel setIsRemovedContact(Boolean value) { this.IsRemovedContact = value; return this; }
    }

}

Java 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>