Notecard Requests & Responses
The Notecard was designed with simplicity and ease of use as a fundamental goal. As such, the Notecard API exclusively consists of JSON requests to the Notecard and JSON responses from the Notecard. Notecard requests should be valid JSON and all follow the format below, where the argument list will vary by request type and usage:
{
"req": "<category.request>",
"argument-one": "value-one",
"argument-two": "value-two",
...
"argument-n": "value-n"
}
For each request, the req
field specifies the category (for example, hub
),
and request (for example, set
).
API Responses--also valid JSON--vary by request and are detailed
for each request in this document and in the
Complete API Reference. For all responses,
an err
field may be present in the returned object. If the err object is not
present in the Notecard response then no error has ocurred. Otherwise, the string
value will indicate the reason for the error.