{"_id":"55ac34a50685ce0d0049fbe1","githubsync":"","parentDoc":null,"version":{"_id":"55aa7d983be8f60d00041d45","__v":20,"project":"55aa7d973be8f60d00041d42","createdAt":"2015-07-18T16:23:52.273Z","releaseDate":"2015-07-18T16:23:52.273Z","categories":["55aa7d983be8f60d00041d46","55aacf4e3be8f60d00041d89","55aacfaae2bdcb0d00c7466e","55aacfb3e2bdcb0d00c7466f","55aacfca3be8f60d00041d8a","55b67da3f8105a2f00c351ab","55b7cae4aea7c8190058ba5b","55b9218afeef5135009b7db3","55c182616d7d2921006da013","5631407afa40240d007c8c60","56548b9c9c4c6d0d00aeda0c","572b9137ff3ba10e00b4abb4","572b9150ff3ba10e00b4abb5","581b83288ca41f0f007e4fb6","585065fa70cbe00f00835bb8","58641eba0355f31900380492","58861760b4816e19005c9941","58a316cb254c401b00a049ce","58ac80dbd5e1570f00d1c328","59f72b4991121a00104f036e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":6,"category":{"_id":"55aa7d983be8f60d00041d46","__v":7,"pages":["55aa7d993be8f60d00041d48","55aa80345d3abb0d0012f3dd","55aa86cc3be8f60d00041d58","55aa86e43be8f60d00041d5a","55ac34a50685ce0d0049fbe1","55ac397063a6b60d0066174d","55c218d5f2cff20d006d0a7d"],"project":"55aa7d973be8f60d00041d42","version":"55aa7d983be8f60d00041d45","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-18T16:23:52.815Z","from_sync":false,"order":0,"slug":"api","title":"API"},"project":"55aa7d973be8f60d00041d42","user":"55aa7d625d3abb0d0012f3da","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-19T23:37:09.478Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Our Error Standard\"\n}\n[/block]\nUserMessage: This is a user-friendly message, which can be displayed on your application. This will be sent when something is wrong on the user side.\nDeveloprMessage: This is message is intended for the developer working with our API. Used to fix an error if he's doing something wrong on his side.\nErrors: Detailed description of the request errors.\nMoreInfo: Links to corresponding API documentation, gives tips, etc.\nStatus: HttpResponse status code.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"userMessage\\\": \\\"You need to fill the username field!\\\",\\n  \\\"developerMessage\\\": \\\"\\\",\\n  \\\"errors\\\": [\\n \\t],\\n  \\\"moreInfo\\\" : \\\"http://developers.cliengo.com/docs/errors\\\", \\n  \\\"status\\\" : 400\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nThe Cliengo API communicates errors through standard HTTP status codes paired with error objects. Generally the following pattern will apply:\n\n2xx\n\nThe request was successfully received, understood, and accepted\n\n3xx\n\nFurther action needs to be taken by the user agent in order to fulfill the request\n\n4xx\n\nAn error in the request. Usually a bad parameter.\n\n5xx\n\nThe request is fine, but something is wrong on Box’s end\n\n## HTTP STATUS CODES\n\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Codes\\n200\\t\\tsuccess\\n201\\t\\tcreated\\n202\\t\\taccepted\\n204\\t\\tno_content\\n302\\t\\tredirect\\n304\\t\\tnot_modified\\n400\\t\\tbad_request\\n401\\t\\tunauthorized\\n403\\t\\tforbidden\\n404\\t\\tnot_found\\n405\\t\\tmethod_not_allowed\\n409\\t\\tconflict\\n412\\t\\tprecondition_failed\\n429 \\ttoo_many_requests\\n500\\t\\tinternal_server_error\\n503 \\tunavailable\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","excerpt":"This page will help you get started with Leadaki. You'll be up and running in a minute!","slug":"errors","type":"basic","title":"Errors"}

Errors

This page will help you get started with Leadaki. You'll be up and running in a minute!

[block:api-header] { "type": "basic", "title": "Our Error Standard" } [/block] UserMessage: This is a user-friendly message, which can be displayed on your application. This will be sent when something is wrong on the user side. DeveloprMessage: This is message is intended for the developer working with our API. Used to fix an error if he's doing something wrong on his side. Errors: Detailed description of the request errors. MoreInfo: Links to corresponding API documentation, gives tips, etc. Status: HttpResponse status code. [block:code] { "codes": [ { "code": "{\n\t\"userMessage\": \"You need to fill the username field!\",\n \"developerMessage\": \"\",\n \"errors\": [\n \t],\n \"moreInfo\" : \"http://developers.cliengo.com/docs/errors\", \n \"status\" : 400\n}", "language": "json" } ] } [/block] The Cliengo API communicates errors through standard HTTP status codes paired with error objects. Generally the following pattern will apply: 2xx The request was successfully received, understood, and accepted 3xx Further action needs to be taken by the user agent in order to fulfill the request 4xx An error in the request. Usually a bad parameter. 5xx The request is fine, but something is wrong on Box’s end ## HTTP STATUS CODES [block:code] { "codes": [ { "code": "Codes\n200\t\tsuccess\n201\t\tcreated\n202\t\taccepted\n204\t\tno_content\n302\t\tredirect\n304\t\tnot_modified\n400\t\tbad_request\n401\t\tunauthorized\n403\t\tforbidden\n404\t\tnot_found\n405\t\tmethod_not_allowed\n409\t\tconflict\n412\t\tprecondition_failed\n429 \ttoo_many_requests\n500\t\tinternal_server_error\n503 \tunavailable", "language": "text" } ] } [/block]