Platform API

IsConnectedInRole

Return true/false if a contact is connected to a licensee in a specific role.

The following routes are available for this service:
All Verbs	/api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId}

**IsConnectedInRole** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	path	Guid	Yes	Contact Id of the contact to determine if they have the role with the licensee.
RoleId	path	Guid	Yes	Role to check for.
LicenseeId	path	Guid	Yes	Licensee Contact Id we are checking if we're connected to.

**IsConnectedInRoleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
IsConnected	form	bool	No	True or false depending on if the contact is connected to the licensee in the role.
ResponseStatus	form	ResponseStatus	No

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}

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

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