Skip to content

Request Parameters

Filter parameters in GET requests are sent using query string parameters.

Date parameters are must be in ISO 8601 datetime format (http://www.w3.org/TR/NOTE-datetime). If just the date part is specified (minus time, e.g., 2019-12-31), then if the parameter is for the start of a query range, then the beginning of the day will used (i.e., 00:00); and if the parameter is for the end of a query range, then end of the day will be used (i.e., 23:59:59). If time is specified (e.g., 2019-12-31T23:59:00Z), then that exact time will be used in the query. If timezone is not specified in the parameter (e.g., 2019-12-31T23:59:00), then the organization unit timezone will be used if that is specified in the query; or otherwise the organization timezone will be used.

Some parameters suppport either single or multiple values, such as querying for multiple organization units. In order to query for multiple values for a specific field, add a opening and closing brackets [] after the field name, as follows:

text
field1[]=value1&field1[]=value2&field2=value2&...

Object data in POST/PUT requests are sent in the requests body in either JSON or XML format, according to the format specified as described in the Content Format section.

Fareclock API Documentation