Platform API

AddConnectionsInRole

Connect two contacts in the specified roles

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

**AddConnectionsInRole** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	path	Guid	Yes	Create a connection from this contact to the specified list of contacts in the specified role.
ToContacts	query	List<GuidLookup>	Yes	List of contacts to add to the role, including the type of contact
RoleId	path	Guid	Yes	Create a connection between contacts in the specified role.
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

**GuidLookup** Parameters:
Name	Parameter	Data Type	Required	Description
LookupId	form	Guid	No
Value	form	Guid	No

**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}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ToContacts: 
	[
		{
			
		}
	],
	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
		}
	}
}