| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetLicenseeConnectedContacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetLicenseeConnectedContacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<SuiteIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SuiteIds>
</GetLicenseeConnectedContacts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserContacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactConnections>
<UserContactConnectionModel>
<ConnectionContactId>00000000-0000-0000-0000-000000000000</ConnectionContactId>
<ConnectionContactListItemRoleId>00000000-0000-0000-0000-000000000000</ConnectionContactListItemRoleId>
<ConnectionContactName>String</ConnectionContactName>
<ConnectionContactPhotoURL>String</ConnectionContactPhotoURL>
<ConnectionContactRoleId>00000000-0000-0000-0000-000000000000</ConnectionContactRoleId>
<ConnectionContactRoleName>String</ConnectionContactRoleName>
<ConnectionId>00000000-0000-0000-0000-000000000000</ConnectionId>
<ConnectionRequestId>00000000-0000-0000-0000-000000000000</ConnectionRequestId>
<ConnectionStatusId>00000000-0000-0000-0000-000000000000</ConnectionStatusId>
<ConnectionStatusName>String</ConnectionStatusName>
<ContactListItemRoleId>00000000-0000-0000-0000-000000000000</ContactListItemRoleId>
<ContactRoleId>00000000-0000-0000-0000-000000000000</ContactRoleId>
<ContactRoleName>String</ContactRoleName>
<ContactRolePrimaryImageId>00000000-0000-0000-0000-000000000000</ContactRolePrimaryImageId>
<ContactRolePrimaryImageThumbnailURL>String</ContactRolePrimaryImageThumbnailURL>
<ContactRolePrimaryImageURL>String</ContactRolePrimaryImageURL>
<ContactTypeName>String</ContactTypeName>
<IsConnectionLicenseeRole>false</IsConnectionLicenseeRole>
<IsContactLicenseeRole>false</IsContactLicenseeRole>
</UserContactConnectionModel>
</ContactConnections>
<EmailAddressBook>
<ContactEmailAddress>
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<ContactName>String</ContactName>
<ContactPhotoURL>String</ContactPhotoURL>
<EmailAddress>String</EmailAddress>
</ContactEmailAddress>
</EmailAddressBook>
</UserContacts>