{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Response bodies","type":"basic","slug":"response-bodies","excerpt":"","body":"Response bodies generally look like:\n\n```json\n{\n    \"count\": 1,\n    \"returned\": 1,\n    \"data\": [\n      {\n        \"AnaCat\": \"potamodromous\",\n        \"AquacultureRef\": 12108,\n        \"Aquarium\": \"never/rarely\",\n        \"AquariumFishII\": \" \",\n        \"AquariumRef\": null,\n        \"Author\": \"(Linnaeus, 1758)\"\n      }\n    ],\n    \"error\": null\n}\n```\n\nResponses have 4 slots:\n\n* count: Number records found\n* returned: Number records returned\n* error: If an error did not occur this is `null`, otherwise, an error message.\n* data: The hash of data if any data returned. If no data found, this is an empty hash (hash of length zero)\n\nResponses with errors also have the same 4 slots, but no data returned, and there should be an\ninformative error message.","updates":[],"order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a0e503e3de7c500262d574f","project":"5508a8940f146f3500b031c9","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5508a8950f146f3500b031cd","5a0e2e283bb0d9001c09e3e1","5a0e2f9844969800124f4d3a","5a0e2fdcc96bc7001288e17d"],"_id":"5508a8950f146f3500b031cc","__v":4,"createdAt":"2015-03-17T22:20:05.001Z","releaseDate":"2015-03-17T22:20:05.001Z","project":"5508a8940f146f3500b031c9"},"category":{"sync":{"isSync":false,"url":""},"pages":["5508a8960f146f3500b031cf"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5508a8950f146f3500b031cd","version":"5508a8950f146f3500b031cc","__v":1,"createdAt":"2015-03-17T22:20:05.520Z","project":"5508a8940f146f3500b031c9"},"user":"5508a87b99a1832100bf9569","createdAt":"2017-11-17T02:58:06.603Z","githubsync":"","__v":0,"parentDoc":null}

Documentation

Routes

Response bodies

Response bodies generally look like: ```json { "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.