{"_id":"563a2dbc1846790d00895314","user":"54d4ec36f6c48a0d00f0f040","__v":1,"version":{"_id":"563a2dba1846790d00895309","__v":3,"project":"54d4ecb5f6c48a0d00f0f041","createdAt":"2015-11-04T16:09:30.844Z","releaseDate":"2015-11-04T16:09:30.844Z","categories":["563a2dbb1846790d0089530a","563a2dbb1846790d0089530b","563a2dbb1846790d0089530c","56620e60f183880d004d3217","5702e5b8f2d6f336005e9025"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"No Mashape","version_clean":"1.1.0","version":"1.1"},"project":"54d4ecb5f6c48a0d00f0f041","category":{"_id":"563a2dbb1846790d0089530a","__v":3,"pages":["563a2dbc1846790d0089530f","563a2dbc1846790d00895310","563a2dbc1846790d00895311","563a2dbc1846790d00895312","563a2dbc1846790d00895313","563a2dbc1846790d00895314","563a2dbc1846790d00895315","563a2dbc1846790d00895316","563a2dbc1846790d00895317","566232310299ea0d008f2cf2","56623a2d0299ea0d008f2cf6"],"project":"54d4ecb5f6c48a0d00f0f041","version":"563a2dba1846790d00895309","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-06T16:32:54.503Z","from_sync":false,"order":2,"slug":"documentation","title":"Documentation"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-10T02:52:00.755Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"Instacount uses a consistent *Errors* payload across all resources to indicate if a request did not succeed.  This payload is a JSON array of error objects, each of which has the following properties:\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**message**\",\n    \"1-0\": \"**developerMessage**\",\n    \"2-0\": \"**moreInfo**\",\n    \"0-1\": \"A plain-text error message that is meant to be displayed to end-users, if desired.\",\n    \"1-1\": \"A plain-text error message that *may* contain technical jargon that a software developer might find useful, but for which an average end-user may not understand.\",\n    \"2-1\": \"A URL that links to more information about the error message, generally useful to a software developer, but not intended for an application end-user.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\nThe following is an example error payload:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"errors\\\": [{\\n      \\\"message\\\": \\\"Counter increment amounts must be positive numbers!\\\",\\n      \\\"developerMessage\\\": \\\"When incrementing a counter, be sure to specify a positive number in your request.\\\",\\n      \\\"moreInfo\\\": \\\"https://instacount.readme.io/docs/errors\\\"\\n  }]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Errors JSON Payload\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"errors","type":"basic","title":"Errors"}
Instacount uses a consistent *Errors* payload across all resources to indicate if a request did not succeed. This payload is a JSON array of error objects, each of which has the following properties: [block:parameters] { "data": { "h-0": "Field Name", "h-1": "Description", "0-0": "**message**", "1-0": "**developerMessage**", "2-0": "**moreInfo**", "0-1": "A plain-text error message that is meant to be displayed to end-users, if desired.", "1-1": "A plain-text error message that *may* contain technical jargon that a software developer might find useful, but for which an average end-user may not understand.", "2-1": "A URL that links to more information about the error message, generally useful to a software developer, but not intended for an application end-user." }, "cols": 2, "rows": 3 } [/block] The following is an example error payload: [block:code] { "codes": [ { "code": "{\n \"errors\": [{\n \"message\": \"Counter increment amounts must be positive numbers!\",\n \"developerMessage\": \"When incrementing a counter, be sure to specify a positive number in your request.\",\n \"moreInfo\": \"https://instacount.readme.io/docs/errors\"\n }]\n}", "language": "json", "name": "Errors JSON Payload" } ] } [/block]