Neotoma Developer Center

Remote programmatic access to the Neotoma Database

User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Last revision Both sides next revision
use [2013/02/21 16:17]
brian [Response Structure]
use [2013/02/21 16:18]
brian [Response Structure]
Line 35: Line 35:
 <​file>​http://​api.neotomadb.org/​v1/​dbtables/​AgeTypes?​format=xml</​file>​ <​file>​http://​api.neotomadb.org/​v1/​dbtables/​AgeTypes?​format=xml</​file>​
 ===== Response Structure ===== ===== Response Structure =====
-Server errors excluded (e.g. HTTP 404), all JSON-formatted responses are structured as a single JSON object with two name:value pairs. ​ The first pair handles request status and the second handles either data, or a status message. The name of the first pair is always "​success;"​ it returns 1 if true, and 0 if false (error). If a request is successful, the second pair name is "​data"​ and its value is an array of data objects. Otherwise, if a request fails, the second pair name is "​message"​ and its value is a string containing a description of the error. XML-formatted responses are structured equivalently using nodes/tags instead of JSON objects; the root tag is <​Results>​.+Server errors excluded (e.g. HTTP 404), all JSON-formatted responses are structured as a single JSON object with two name:value pairs. ​ The first pair handles request status and the second handles either data, or a status message. The name of the first pair is always "​success;"​ it returns 1 if true, and 0 if false (error). If a request is successful, the second pair name is "​data"​ and its value is an array of data objects. Otherwise, if a request fails, the second pair name is "​message"​ and its value is a string containing a description of the error. 
 + 
 +XML-formatted responses are structured equivalently using nodes/tags instead of JSON objects; the root tag is <​Results>​.
  
 <​file>​ <​file>​

Page Tools