Platform API

ContactConnectedLinks

Retrieve links to a contact (connections/roles/emailAddressBook

The following routes are available for this service:
All Verbs	/api/contacts/{ContactId}/links

**ContactConnectedLinks** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	path	Guid	No

**ContactConnectedLinksResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Roles	query	List<UserRoleModel>	No	A list of roles assigned to the contact/user.
ContactConnections	query	List<UserContactConnectionModel>	No	A list of contact connections assigned to the contact/user.
EmailAddressBook	query	List<ContactEmailAddressBook>	No	A list of connected contacts and their email addresses.
ResponseStatus	form	ResponseStatus	No

**UserRoleModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactRoleId	query	Guid	No	The Contact Role Id, that links the Contact to their role.
RoleId	query	Guid	No	The Role Id.
RoleName	query	string	No	The role name.
RolePrimaryImageURL	query	string	No	The URL of the role's image icon.
RolePrimaryImageThumbnailURL	query	string	No	The URL of the role's thumbnail image icon.
RolePrimaryImageId	query	string	No	The Guid of the role's media file containing the image icon details.
StartDate	query	DateTime	No	The date the contact started having this role.
EndDate	query	DateTime?	No	The date the contact will end having this role.

**UserContactConnectionModel** Parameters:
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.

**ContactEmailAddress** Parameters:
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

HTTP + XML

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

POST /api/contacts/{ContactId}/links HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContactConnectedLinks 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>
</ContactConnectedLinks>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactConnectedLinksResponse 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>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Roles>
    <UserRoleModel>
      <ContactRoleId>00000000-0000-0000-0000-000000000000</ContactRoleId>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
      <RoleName>String</RoleName>
      <RolePrimaryImageId>00000000-0000-0000-0000-000000000000</RolePrimaryImageId>
      <RolePrimaryImageThumbnailURL>String</RolePrimaryImageThumbnailURL>
      <RolePrimaryImageURL>String</RolePrimaryImageURL>
      <StartDate>0001-01-01T00:00:00</StartDate>
    </UserRoleModel>
  </Roles>
</ContactConnectedLinksResponse>