Response bodies generally look like:

    "count": 1,
    "returned": 1,
    "data": [
        "AnaCat": "potamodromous",
        "AquacultureRef": 12108,
        "Aquarium": "never/rarely",
        "AquariumFishII": " ",
        "AquariumRef": null,
        "Author": "(Linnaeus, 1758)"
    "error": null

Responses have 4 slots:

  • count: Number records found
  • returned: Number records returned
  • error: If an error did not occur this is null, otherwise, an error message.
  • data: The hash of data if any data returned. If no data found, this is an empty hash (hash of length zero)

Responses with errors also have the same 4 slots, but no data returned, and there should be an
informative error message.