Difference between revisions of "API:Appointments:Updated"

From docs
Jump to: navigation, search
(Created page with " == API » Updated Appointments == '''URL:''' <nowiki>https://app.callproof.com/api/appts/updated/</nowiki> '''Method:''' GET '''Required Fields:''' * '''''key''''...")
 
 
Line 16: Line 16:
 
* '''''before''''' - Date/Time Appointments were updated after (e.g. '2014-08-10 12:34:56')
 
* '''''before''''' - Date/Time Appointments were updated after (e.g. '2014-08-10 12:34:56')
 
* '''''offset''''' - Only 10 Appointments are returned per request, this field must be used to pull additional results when more are available
 
* '''''offset''''' - Only 10 Appointments are returned per request, this field must be used to pull additional results when more are available
 +
* '''''filter_type''''' - Get appointments according to date filter ('created', 'updated'). Default is 'updated'. If filter type is 'created' then most recently created appears first in order.
  
 
'''Data Returned:'''
 
'''Data Returned:'''

Latest revision as of 08:54, 8 August 2017

API » Updated Appointments

URL: https://app.callproof.com/api/appts/updated/

Method: GET

Required Fields:

  • key - API Key
  • secret - API Key Secret
  • after - Date/Time Appointments were updated after (e.g. '2014-08-10 12:34:56')

Optional Fields:

  • before - Date/Time Appointments were updated after (e.g. '2014-08-10 12:34:56')
  • offset - Only 10 Appointments are returned per request, this field must be used to pull additional results when more are available
  • filter_type - Get appointments according to date filter ('created', 'updated'). Default is 'updated'. If filter type is 'created' then most recently created appears first in order.

Data Returned:

  • results - Array of Appointments
  • more - This field will be set if additional results are available
  • offset - Current offset of the request
  • errors - Array of errors produced by the request
  • code - HTTP request status