Platform API

GetObjectContactConnections

Get contact connections for the specified object.

The following routes are available for this service:
GET	/api/objects/{ObjectId}/contactconnections
GET	/api/projects/{ObjectId}/myteam

**GetObjectContactConnections** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	path	Guid	Yes	Object Id to get contact connections for

**GetObjectContactConnectionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ContactConnections	form	List<ObjectContactConnectionModel>	No
ResponseStatus	form	ResponseStatus	No

**ObjectContactConnectionModel** Parameters:
Name	Parameter	Data Type	Required
ObjectContactConnectionId	form	Guid	No
ContactRoleConnectionId	form	Guid	No
ObjectId	form	Guid	No
Contact	form	ContactSummaryModel	No
RoleId	form	Guid	No
RoleName	form	string	No
Created	form	DateTime	No

**ContactSummaryModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	form	Guid	No	Contact linked to the profile
ContactFullName	form	string	No	Full name of the contact linked to the profile
EmailAddress	form	string	No	Email Address of the contact linked to the profile
MobileNumber	form	string	No	Mobile Number of the contact linked to the profile
PhoneNumber	form	string	No	Primary Phone Number of the contact linked to the profile
ContactTypeId	form	string	No	Type of contact (person, organisation etc.) linked to the profile
ProfilePhotoUrl	form	string	No	Profile photo of contact linked to the profile
ProfilePhotoThumbnailUrl	form	string	No	Thumbnail photo of contact linked to the profile
Description	form	string	No	Profile description
EmploymentIndustry	form	string	No	Employment Industry
EmploymentRole	form	string	No	Employment Role
EmploymentGeographicArea	form	string	No	Areas of Work
TimezoneName	query	string	No	Timezone Name
PrimaryAddress	query	string	No	The primary address of the contact
IsRemovedContact	form	bool	No	Have all connections to the contact been removed?

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

HTTP + JSV

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: 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
		}
	}
}