Platform API

<back to all web services

GetObjectContactConnections

Get contact connections for the specified object.

"use strict";
export class ContactSummaryModel {
    /** @param {{ContactId?:string,ContactFullName?:string,EmailAddress?:string,MobileNumber?:string,PhoneNumber?:string,ContactTypeId?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,TimezoneName?:string,PrimaryAddress?:string,IsRemovedContact?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Contact linked to the profile */
    ContactId;
    /**
     * @type {string}
     * @description Full name of the contact linked to the profile */
    ContactFullName;
    /**
     * @type {string}
     * @description Email Address of the contact linked to the profile */
    EmailAddress;
    /**
     * @type {string}
     * @description Mobile Number of the contact linked to the profile */
    MobileNumber;
    /**
     * @type {string}
     * @description Primary Phone Number of the contact linked to the profile */
    PhoneNumber;
    /**
     * @type {string}
     * @description Type of contact (person, organisation etc.) linked to the profile */
    ContactTypeId;
    /**
     * @type {string}
     * @description Profile photo of contact linked to the profile */
    ProfilePhotoUrl;
    /**
     * @type {string}
     * @description Thumbnail photo of contact linked to the profile */
    ProfilePhotoThumbnailUrl;
    /**
     * @type {string}
     * @description Profile description */
    Description;
    /**
     * @type {string}
     * @description Employment Industry */
    EmploymentIndustry;
    /**
     * @type {string}
     * @description Employment Role */
    EmploymentRole;
    /**
     * @type {string}
     * @description Areas of Work */
    EmploymentGeographicArea;
    /**
     * @type {string}
     * @description Timezone Name */
    TimezoneName;
    /**
     * @type {string}
     * @description The primary address of the contact */
    PrimaryAddress;
    /**
     * @type {boolean}
     * @description Have all connections to the contact been removed? */
    IsRemovedContact;
}
export class ObjectContactConnectionModel {
    /** @param {{ObjectContactConnectionId?:string,ContactRoleConnectionId?:string,ObjectId?:string,Contact?:ContactSummaryModel,RoleId?:string,RoleName?:string,Created?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ObjectContactConnectionId;
    /** @type {string} */
    ContactRoleConnectionId;
    /** @type {string} */
    ObjectId;
    /** @type {ContactSummaryModel} */
    Contact;
    /** @type {string} */
    RoleId;
    /** @type {string} */
    RoleName;
    /** @type {string} */
    Created;
}
export class GetObjectContactConnectionsResponse {
    /** @param {{ContactConnections?:ObjectContactConnectionModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ObjectContactConnectionModel[]} */
    ContactConnections;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetObjectContactConnections {
    /** @param {{ObjectId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Object Id to get contact connections for */
    ObjectId;
}

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