Platform API

GetConnectionsToContact

Get connections to the specified contact for the requestor contact

The following routes are available for this service:
All Verbs	/api/contacts/{ContactId}/connections

**GetConnectionsToContact** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	path	Guid	Yes	Contact Id to get connections for
ContactTypeId	query	Guid	Yes	Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)
RequestorContactId	query	Guid	Yes	Contact Id requesting the details - Current user or licensee
IsPagedMode	query	bool	No	Return all connections or paged results?
IncludeRemoved	query	bool	No	Option to return removed connections

**PagedModel** Parameters:
Name	Parameter	Data Type	Required	Description
PageNumber	form	int	No	Page Number to retrieve
PageSize	form	int	No	Number of records to retrieve
SortIndex	form	int	No	Index of field to sort results by
SortOrder	form	int	No	Sort Order - Ascending or Descending

**SortOrder** Enum:
Ascending
Descending

**GetConnectionsToContactResponse** Parameters:
Name	Parameter	Data Type	Required
Connections	form	List<ContactConnectionModel>	No
TotalConnections	form	int	No
ResponseStatus	form	ResponseStatus	No

**ContactConnectionModel** Parameters:
Name	Parameter	Data Type	Required	Description
ConnectionId	form	Guid?	No	Connection Id (if applicable)
ConnectionRequestId	form	Guid?	No	Connection Request Id (if applicable)
Contact	form	ContactSummaryModel	Yes	Details of the contact
ContactRoleId	form	Guid	Yes	Contact's role Id in the connection
ContactRoleName	form	string	No	Contact's role name in the connection
RequestorContactId	form	Guid	Yes	Requestor Contact Id
RequestorContactName	form	Guid	No	Requestor Contact Name
RequestorRoleId	form	Guid	Yes	Requestor contact's role Id in the connection
RequestorRoleName	form	string	No	Requestor's role name in the connection
PrimaryRoleName	form	string	No	Primary role in the connection to display
ConnectionStatusId	form	Guid	Yes	Connection Status Id
ConnectionStatusName	form	string	No	Connection Status Name
IsConnectionRequest	form	bool	No	Is this a pending connection request?
IsIncoming	form	bool	No	Is this an incoming connection request?
FromDate	form	DateTime?	No
SuggesterContact	form	ContactSummaryModel	Yes	Details of the contact suggesting this connection
AllowCancel	form	bool	No	Can this connection be cancelled?
AllowRemove	form	bool	No	Can this connection be removed?

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

POST /api/contacts/{ContactId}/connections HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IsPagedMode: False,
	IncludeRemoved: False,
	PageNumber: 0,
	PageSize: 0,
	SortIndex: 0,
	SortOrder: Ascending
}

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

{
	Connections: 
	[
		{
			ConnectionId: 00000000000000000000000000000000,
			ConnectionRequestId: 00000000000000000000000000000000,
			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
			},
			ContactRoleName: String,
			RequestorContactName: String,
			RequestorRoleName: String,
			PrimaryRoleName: String,
			ConnectionStatusName: String,
			IsConnectionRequest: False,
			IsIncoming: False,
			FromDate: 0001-01-01,
			SuggesterContact: 
			{
				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
			},
			AllowCancel: False,
			AllowRemove: False
		}
	],
	TotalConnections: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}