{"_id":"565f79846c2a8d0d00276553","category":{"_id":"565f790d6bafd40d0030a09f","version":"55de36ec9067202b00de0015","__v":5,"pages":["565f79846c2a8d0d00276553","565f7a2a813aeb0d007b7588","565f80a2813aeb0d007b7592","565f80f4bca87d0d006bc759","565f812413f6680d0022df2e"],"project":"55dd0853d2d97337001800e2","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-02T23:04:45.791Z","from_sync":false,"order":9,"slug":"errors","title":"Errors"},"githubsync":"","user":"55dd080d0efd5821000d53b3","project":"55dd0853d2d97337001800e2","__v":23,"parentDoc":null,"version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-02T23:06:44.712Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"error\\\": {\\n    \\\"name\\\": \\\"unprocessableEntity\\\",\\n    \\\"status\\\": \\\"422\\\",\\n    \\\"type\\\": \\\"requestError\\\",\\n    \\\"description\\\": \\\"There was a problem with the request.\\\",\\n    \\\"details\\\": {\\n      \\\"code\\\": \\\"validationError\\\",\\n      \\\"detailCode\\\": \\\"\\\",\\n      \\\"description\\\": \\\"There are requirements that have not been met.\\\",\\n      \\\"parameter\\\": \\\"amount\\\",\\n      \\\"explanation\\\": \\\"amount is required\\\"\\n    },\\n    \\\"ref\\\": \\\"5540b94cffee444cb4e12b761ca93183\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example Error Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nThe Error response structure contains a [HTTP Status Code](doc:http-status-codes), an [Error Type](doc:error-types), an [Error Code](doc:error-detail-codes), a reference id, and (optionally) other details to further understand the nature of the error. The Error response has a root element \"error\" containing the error structure.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"error\",\n    \"0-1\": \"Errors come wrapped in a root object named \\\"error\\\". See below.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n## Error\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"name\",\n    \"1-0\": \"status\",\n    \"2-0\": \"type\",\n    \"3-0\": \"description\",\n    \"4-0\": \"details\",\n    \"5-0\": \"ref\",\n    \"0-1\": \"The [HTTP Status Codes](doc:http-status-codes) name\",\n    \"1-1\": \"The [HTTP Status Code](doc:http-status-codes)\",\n    \"2-1\": \"The [Error Type](doc:error-types)\",\n    \"3-1\": \"The description for the [Error Type](doc:error-types)\",\n    \"5-1\": \"A reference code given to each error.\",\n    \"4-1\": \"An embedded details object. See below.\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n## Details\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"code\",\n    \"1-0\": \"description\",\n    \"3-0\": \"parameter\",\n    \"4-0\": \"value\",\n    \"5-0\": \"explanation\",\n    \"0-1\": \"The [Error Details Codes](doc:error-detail-codes).\",\n    \"1-1\": \"The description for the [Error Detail Code](doc:error-detail-codes).\",\n    \"3-1\": \"The parameter associated with the error (if available).\",\n    \"4-1\": \"The parameter values associated with the error (if available).\",\n    \"5-1\": \"A more detailed explanation of the error (if available).\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"2-0\": \"detailCode\",\n    \"2-1\": \"A code given to describe the specific details of the error.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"error-resource","type":"basic","title":"Errors resource"}
[block:code] { "codes": [ { "code": "{\n \"error\": {\n \"name\": \"unprocessableEntity\",\n \"status\": \"422\",\n \"type\": \"requestError\",\n \"description\": \"There was a problem with the request.\",\n \"details\": {\n \"code\": \"validationError\",\n \"detailCode\": \"\",\n \"description\": \"There are requirements that have not been met.\",\n \"parameter\": \"amount\",\n \"explanation\": \"amount is required\"\n },\n \"ref\": \"5540b94cffee444cb4e12b761ca93183\"\n }\n}", "language": "json", "name": "Example Error Response" } ], "sidebar": true } [/block] The Error response structure contains a [HTTP Status Code](doc:http-status-codes), an [Error Type](doc:error-types), an [Error Code](doc:error-detail-codes), a reference id, and (optionally) other details to further understand the nature of the error. The Error response has a root element "error" containing the error structure. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "error", "0-1": "Errors come wrapped in a root object named \"error\". See below." }, "cols": 2, "rows": 1 } [/block] ## Error [block:parameters] { "data": { "0-0": "name", "1-0": "status", "2-0": "type", "3-0": "description", "4-0": "details", "5-0": "ref", "0-1": "The [HTTP Status Codes](doc:http-status-codes) name", "1-1": "The [HTTP Status Code](doc:http-status-codes)", "2-1": "The [Error Type](doc:error-types)", "3-1": "The description for the [Error Type](doc:error-types)", "5-1": "A reference code given to each error.", "4-1": "An embedded details object. See below.", "h-0": "Parameter", "h-1": "Description" }, "cols": 2, "rows": 6 } [/block] ## Details [block:parameters] { "data": { "0-0": "code", "1-0": "description", "3-0": "parameter", "4-0": "value", "5-0": "explanation", "0-1": "The [Error Details Codes](doc:error-detail-codes).", "1-1": "The description for the [Error Detail Code](doc:error-detail-codes).", "3-1": "The parameter associated with the error (if available).", "4-1": "The parameter values associated with the error (if available).", "5-1": "A more detailed explanation of the error (if available).", "h-0": "Parameter", "h-1": "Description", "2-0": "detailCode", "2-1": "A code given to describe the specific details of the error." }, "cols": 2, "rows": 6 } [/block]