Platform API

<back to all web services

GetObjectContactConnections

Get contact connections for the specified object.

import Foundation
import ServiceStack

/**
* Get contact connections for the specified object.
*/
// @Api(Description="Get contact connections for the specified object.")
public class GetObjectContactConnections : Codable
{
    /**
    * Object Id to get contact connections for
    */
    // @ApiMember(DataType="Guid", Description="Object Id to get contact connections for", IsRequired=true, Name="ObjectId")
    public var objectId:String

    required public init(){}
}

// @ApiResponse(Description="Returns the contact connections for the specified object.")
public class GetObjectContactConnectionsResponse : Codable
{
    public var contactConnections:[ObjectContactConnectionModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ObjectContactConnectionModel : Codable
{
    public var objectContactConnectionId:String
    public var contactRoleConnectionId:String
    public var objectId:String
    public var contact:ContactSummaryModel
    public var roleId:String
    public var roleName:String
    public var created:Date

    required public init(){}
}

public class ContactSummaryModel : Codable
{
    /**
    * Contact linked to the profile
    */
    // @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    public var contactId:String

    /**
    * 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 var contactFullName:String

    /**
    * 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 var emailAddress:String

    /**
    * 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 var mobileNumber:String

    /**
    * 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 var phoneNumber:String

    /**
    * 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 var contactTypeId:String

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

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

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

    /**
    * Employment Industry
    */
    // @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    public var employmentIndustry:String

    /**
    * Employment Role
    */
    // @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    public var employmentRole:String

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

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

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

    /**
    * Have all connections to the contact been removed?
    */
    // @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
    public var isRemovedContact:Bool

    required public init(){}
}

Swift GetObjectContactConnections DTOs

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

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ContactConnections: 
	[
		{
			Contact: 
			{
				ContactFullName: String,
				EmailAddress: String,
				MobileNumber: String,
				PhoneNumber: String,
				ProfilePhotoUrl: String,
				ProfilePhotoThumbnailUrl: String,
				Description: String,
				EmploymentIndustry: String,
				EmploymentRole: String,
				EmploymentGeographicArea: String,
				TimezoneName: String,
				PrimaryAddress: String,
				IsRemovedContact: False
			},
			RoleName: String,
			Created: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}