Fullscreen on/off iPad Touch Mobile

API Reference

The API Reference manual for IvyRoot detailing the URL's, methods and responses.

Documentation in this section

RESTful

The API for IvyRoot is based on REST principles. Resources are identified through the URI and manipulated through HTTP methods. ...

Authentication

All queries into the API are authenticated. You need to have an IvyRoot account to access the API and this ...

API URLs

All API URLs follow a common form. The format can be described as an extension of "http://www.w3.org/Addressing/URL/5_BNF.html#z0":http://www.w3.org/Addressing/URL/5_BNF.html bc. format = ...

API Resources

The IvyRoot API operates on the following resources identified through URIs. * categories - Hierarchy for organising measures * comments ...

API Elements

API elements are the entities which make up resources. Each resource is a collection of elements referenced by a unique ...

HTTP Methods

The following table illustrates the operation of the different HTTP Methods on the API. |Resource|GET|PUT|POST|DELETE| |Collection URI: http://ivyroot.com/api/resource/|List the members ...

Successful responses

Responses to the API that are successful will have a 200 HTTP response code and contain a document body that ...

Error Responses

Error responses from the API are dependent on context. In order to verify that a request has completed successfully you ...

Resources

This section details the permissible values within entities for each resource and their rules for creation, update and querying. * ...