Data Formats

JSON Responses

Responses to successful requests have a response body consisting of a JSON hash (for single records) or a JSON array of JSON hashes (for multiple records).

Date/Time Strings

Date/time representations should conform to ISO 8601

This format is:

[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss][Z]

where Z is a literal ‘Z’ for GMT, or (+/-)hh:mm for an offset from GMT.

Store Defaults in a Config File

To simplify curl requests, create a config file.

With Basic Authentication, use your login information to create a file similar to the following:

% cat ~/.liquidplanner_curl
compressed
user: [email protected]:api_password
-H "Content-Type: application/json"
write-out: "\nStatus: %{http_code}\n"

If you use Token-Based authentication, include your token instead, like this:

% cat ~/.liquidplanner_curl
compressed
-H "Authorization: Bearer 12312312-1232-2321-1231-123123123123"
-H "Content-Type: application/json"
write-out: "\nStatus: %{http_code}\n"

This tells curl to ask for and to handle a compressed response, provides your credentials, specifies that POSTed data is JSON-encoded (rather than form-encoded), and instructs curl to output the HTTP status code after the response body (which is useful for troubleshooting).

To keep your password secure, make the config file readable only by you (using chmod on Linux, Mac OS X, etc.):

% chmod 600 ~/.liquidplanner_curl