| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | query | Guid | Yes | The user's Guid. Contacts retrieved will be connected to this user. |
| ContactId | query | Guid | Yes | The user profiles Contact Guid. Contacts connected to the user will be filted by this profiles contact ID. |
| SuiteIds | query | List<Guid> | No | The suite id list. Gets contacts connected to the user filted by the suite IDs in this list.. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactConnections | query | List<UserContactConnectionModel> | No | A list of contact connections assigned to the user. |
| EmailAddressBook | query | List<ContactEmailAddressBook> | No | A list of connected contacts and their email addresses. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactRoleId | query | Guid | No | The Contact Role Id, that links the Contact to their role. |
| ContactRoleName | query | string | No | The role name. |
| ContactListItemRoleId | query | Guid | No | The list item role Id. |
| ContactRolePrimaryImageURL | query | string | No | The URL of the contact role's image icon. |
| ContactRolePrimaryImageThumbnailURL | query | string | No | The URL of the contact role's thumbnail image icon. |
| ContactRolePrimaryImageId | query | string | No | The Guid of the contact role's media file containing the image icon details. |
| ConnectionContactId | query | string | No | The connected contacts Id. (licensee) |
| ConnectionContactName | query | string | No | The connected contacts Full Name. |
| ConnectionContactRoleName | query | string | No | The connected contacts role. |
| ConnectionContactRoleId | query | Guid | No | The connected contacts role Id. |
| ConnectionContactListItemRoleId | query | Guid | No | The connected contacts list item role Id. |
| ContactTypeName | query | string | No | The Contacts Type. |
| ConnectionContactPhotoURL | query | string | No | The URL to the Connected Contacts Photo. |
| IsContactLicenseeRole | query | bool | No | . |
| IsConnectionLicenseeRole | query | bool | No | If the connection is as a licensee this is true. |
| ConnectionStatusName | query | string | No | The status of the connection with the contact. |
| ConnectionStatusId | query | Guid | No | The status Id of the connection with the contact. |
| ConnectionId | query | Guid | No | The ContactRoleConnectionId of an active connection with the contact. |
| ConnectionRequestId | query | Guid | No | The ContactRoleConnectionRequest of a pending connection with the contact. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | query | Guid | No | The Contact Id of the contact. |
| ContactName | query | string | No | The Contact Full Name |
| EmailAddress | query | string | No | The Contact Email Address. |
| ContactPhotoURL | query | string | No | The Contact Photo URL |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/GetConnectedContacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"UserId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","SuiteIds":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ContactConnections":[{"ContactRoleId":"00000000-0000-0000-0000-000000000000","ContactRoleName":"String","ContactListItemRoleId":"00000000-0000-0000-0000-000000000000","ContactRolePrimaryImageURL":"String","ContactRolePrimaryImageThumbnailURL":"String","ContactRolePrimaryImageId":"00000000-0000-0000-0000-000000000000","ConnectionContactId":"00000000-0000-0000-0000-000000000000","ConnectionContactName":"String","ConnectionContactRoleName":"String","ConnectionContactRoleId":"00000000-0000-0000-0000-000000000000","ConnectionContactListItemRoleId":"00000000-0000-0000-0000-000000000000","ContactTypeName":"String","ConnectionContactPhotoURL":"String","IsContactLicenseeRole":false,"IsConnectionLicenseeRole":false,"ConnectionStatusName":"String","ConnectionStatusId":"00000000-0000-0000-0000-000000000000","ConnectionId":"00000000-0000-0000-0000-000000000000","ConnectionRequestId":"00000000-0000-0000-0000-000000000000"}],"EmailAddressBook":[{"ContactId":"00000000-0000-0000-0000-000000000000","ContactName":"String","EmailAddress":"String","ContactPhotoURL":"String"}]}