API Functions

The following functions have been created for the API.

Note that your access to these functions may be limited by the restrictions on your App. Use app_details to check restrictions.

• app_details
• user_productions
• lookups
• read_all
• create
• update
• read
• delete

View the individual function documentation linked above for details of what they expect to receive. In general though, JSON format request expected by the functions is as follows:

{
   // The API function you wish to use.
   "action": "function", // string

   // The email address of the user whose records you are working with
   "user": "api@greenlit.org.nz", // email address string

   // The production identifying code
   "production": "YmU9U5evebUbUjagydejU3Ehuna2a2", // string

   // The key for the production
   "key": "50d95141da41a5e502ada5c7da7de33d" // string

   // An array of record IDs
   "records": {}, // array of integers

   // An array of record arrays
   "data": {} // array of arrays
}

Responses you can expect are as follows:

{
    "status": "success", // or partial, or error
    "error": "", // error message here
    "data": [], // records returned
    "actions": [], // details regarding success of each record
    "lookups": {} // lookup tables for relational fields
}

However, immediate errors will return the following:

{
    "error": "No data sent" // message for error
}