Platform API

ConnectContactsInRoles

Connect two contacts in the specified roles

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

**ConnectContactsInRoles** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	path	Guid	Yes	Create a connection from this contact to the specified to contact in the specified roles.
ToContactId	path	Guid	Yes	Create a connection to this contact from the specified to contact in the specified roles.
ContactTypeId	query	Guid	Yes	Type of contact being connected with. For e.g. Real Person, Virtual Person etc.
Roles	query	List<Guid>	Yes	List of roles to connect contacts in
SendConnectionEmails	query	boolean	Yes	Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance

**ConnectContactsInRolesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

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/connections/{ContactId}/to/{ToContactId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Roles: 
	[
		00000000-0000-0000-0000-000000000000
	],
	SendConnectionEmails: False
}

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}