Overview
Get notes for a specified contact via an http form post.
Post Url
https://www.allclients.com/api/2/GetContactNotes.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Important Note
Submitting a blank field will result in clearing the data for that field out of the database. If you don’t want to change a field, do not submit it with the form.
Note dates are in US Central Standard Time
notecontent is wrapped in a CDATA tag. This allows special characters to reside in an XML document without hurting the integrity of the XML.
Form Fields
| Field | Max Length* | Required | Notes |
| response_type | No | Default results will be returned in XML.Set this field value to json to return results in JSON format | |
| accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| identifymethod | 1 | Yes | Values:1 : By contactid (It’s recommended that you use this method and store our contactid in your system)
2 : By primary email on file. If there are multiple matches for the email address, we will choose the first one (by add date) 3: By email or other email on file. If there are multiple matches for the email address, we will choose the first one (by add date) |
| identifyvalue | 75 | Yes | Value changes based on indentifymethod. Must be integer if contactid, otherwise must be an email address on file |
* An error will not result if Max Length is exceeded. Data will be trimmed to this length.
Sample Results
Success Message
<?xml version="1.0"?>
<results>
<notes>
<note>
<date>10/2/2014 3:22 PM</date>
<notecontent><![CDATA[Called customer. No answer.]]></notecontent>
</note>
<note>
<date>10/8/2014 4:15 PM</date>
<notecontent><![CDATA[Customer called and ordered 17 widgets.]]></notecontent>
</note>
</notes>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>
<?xml version="1.0"?>
<results>
<error>Get Notes failed: Contact not found</error>
</results>
