Overview
Retrieve appointment data within date ranges, with some related data. Intended for reporting data. Communication handled via an http form post.
Post Url
https://www.allclients.com/api/2/StatsAppointmentDetail.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
| Field | Max Length* | Required | Notes |
| response_type |
Default results will be returned in XML.
Set this field value to json to return results in JSON format
|
||
| accountid | Yes | Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| teammemberid | No | Optional Team Member ID filter | |
| contactid | No | Optional Contact ID filter | |
| apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| startdate | 10 | Yes | Add Date of the contact is on or after this date (Use US date format: mm/dd/yyyy) |
| enddate | 10 | Yes | Add Date of the contact is before this date (Use US date format:mm/dd/yyyy)
Note: Using value 6/30/2012 will not include contacts added on 6/30. Use 7/1/2013 to include contacts added BEFORE this date. |
| detail | 1 | No | Set this value to “1” to return the description, details, and color fields for each appointment |
* 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> <result> <appointmentid>1039</appointmentid> <date>12/13/2017</date> <startdatetime>12/13/2017 9:00:00 AM</startdatetime> <enddatetime>12/13/2017 10:00:00 AM</enddatetime> <teammemberid>0</teammemberid> <contactid>14224</contactid> <contactsourceid>1447</contactsourceid> <contactsourcename>Yellow Pages</contactsourcename> </result> </results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>
