{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Response Codes","type":"basic","slug":"response-codes","excerpt":"","body":"These are the most common server responses you will encounter when using the Fleetio API.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"Everything went as expected! Used on `index` and `show` actions.\",\n    \"0-2\": \"\",\n    \"1-0\": \"201 Created\",\n    \"1-1\": \"Used on `create` actions. A 201 means that a record was created successfully. Check the `location` header for the url of the newly created object.\",\n    \"1-2\": \"\",\n    \"2-0\": \"204 No Content\",\n    \"2-1\": \"Denotes that an action was successful, but the API does not need to return any data. Used on `update` and `delete` actions.\",\n    \"2-2\": \"\",\n    \"3-0\": \"401 Unauthorized\",\n    \"3-1\": \"Your credentials syntax is not correct, or your credentials are invalid. The response body will be `\\\"HTTP Token: Access denied\\\"`. If you are getting this error, please review the [Getting Started](doc:getting-started) guide.\",\n    \"3-2\": \"\",\n    \"4-0\": \"403 Forbidden\",\n    \"4-1\": \"You are trying to access an endpoint for which the user associated with your API key does not have permissions to access. There will not be anything in the response body. If you are getting this error, please check that the endpoint is correct and check the permissions of the user and be sure they can actually do the action you are attempting. You can learn more in the Help Center article about [User Roles & Permissions](https://help.fleetio.com/hc/en-us/articles/360019211872-User-Roles-Permissions) as well as the [Full Permissions Reference](https://help.fleetio.com/hc/en-us/articles/360019528231-Fleetio-Manage-Permissions-Reference).\",\n    \"4-2\": \"\",\n    \"5-0\": \"422 Unprocessable Entity\",\n    \"5-1\": \"This is returned if a record cannot be `created` or `updated`, usually due to validation errors. If you receive this response code check the response body for error messages.\\n\\nThis hash will have one key for each field with errors. Each field will have an array of human readable error messages, as shown below:\\n\\n```\\n{\\n  \\\"errors\\\": {\\n    \\\"name\\\": [\\n      \\\"can't be blank\\\"\\n    ],\\n    \\\"meter_unit\\\": [\\n      \\\"can't be blank\\\",\\n      \\\"is not a valid value. Please specify one of the predefined values for this field.\\\"\\n    ]\\n  }\\n}\\n```\",\n    \"5-2\": \"\",\n    \"7-0\": \"500 Internal Server Error\",\n    \"7-1\": \"Ideally you should never see this, but if you do, you've probably found a bug. Yes it's true, we make bugs too. We have automated monitoring of these errors, and we try to fix them proactively, but if its a problem and its messing up your day, please [tell us about it](https://help.fleetio.com/hc/en-us/requests/new). It is also possible that our servers are down, so be sure to check out our [System Status](https://status.fleetio.com/) page for information about our servers and their current health.\",\n    \"7-2\": \"\",\n    \"6-0\": \"429 Too Many Requests\",\n    \"6-2\": \"\",\n    \"6-1\": \"The Fleetio API implements a simple throttle of 20 requests per minute. Exceeding this limit will result in this response code. The response body will be \\\"Too many requests detected from your IP. Please try again later. If you believe this is an error, please contact Fleetio Support at help:::at:::fleetio.com\\\". The response will also include a `Retry-After` header whose value represents the number of seconds until the rate limit has been lifted. For example, `Retry-After: 60` means that you need to wait 60 seconds before making another request to the Fleetio API.\",\n    \"h-0\": \"Status Code\",\n    \"h-2\": \"\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54f8de4f4339bb1900c8c012","category":{"sync":{"isSync":false,"url":""},"pages":["54f8de4f4339bb1900c8c010","54f8de4f4339bb1900c8c011","54f8de4f4339bb1900c8c012","54f8de4f4339bb1900c8c013"],"title":"Fleetio API","slug":"fleetio-api","order":0,"from_sync":false,"reference":false,"_id":"54f8de4e4339bb1900c8bffc","__v":1,"createdAt":"2015-01-22T11:54:59.216Z","project":"54c0e51215af820d001a38a6","version":"54f8de4e4339bb1900c8bffb"},"parentDoc":null,"project":"54c0e51215af820d001a38a6","user":"54c0e50215af820d001a38a5","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d","5c7030f099eeb6003116a106","5c9553a7b6957d005006fc09","5c955c3d04233b0063c9f450","5cfe73f7823bba005de7e1ed","5d07eb760568e70040d6ae21","5deec6550e90370067139979","5ec5a01754009700689296af"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":40},"__v":1,"createdAt":"2015-03-03T21:51:51.461Z","githubsync":""}
These are the most common server responses you will encounter when using the Fleetio API. [block:parameters] { "data": { "0-0": "200 OK", "0-1": "Everything went as expected! Used on `index` and `show` actions.", "0-2": "", "1-0": "201 Created", "1-1": "Used on `create` actions. A 201 means that a record was created successfully. Check the `location` header for the url of the newly created object.", "1-2": "", "2-0": "204 No Content", "2-1": "Denotes that an action was successful, but the API does not need to return any data. Used on `update` and `delete` actions.", "2-2": "", "3-0": "401 Unauthorized", "3-1": "Your credentials syntax is not correct, or your credentials are invalid. The response body will be `\"HTTP Token: Access denied\"`. If you are getting this error, please review the [Getting Started](doc:getting-started) guide.", "3-2": "", "4-0": "403 Forbidden", "4-1": "You are trying to access an endpoint for which the user associated with your API key does not have permissions to access. There will not be anything in the response body. If you are getting this error, please check that the endpoint is correct and check the permissions of the user and be sure they can actually do the action you are attempting. You can learn more in the Help Center article about [User Roles & Permissions](https://help.fleetio.com/hc/en-us/articles/360019211872-User-Roles-Permissions) as well as the [Full Permissions Reference](https://help.fleetio.com/hc/en-us/articles/360019528231-Fleetio-Manage-Permissions-Reference).", "4-2": "", "5-0": "422 Unprocessable Entity", "5-1": "This is returned if a record cannot be `created` or `updated`, usually due to validation errors. If you receive this response code check the response body for error messages.\n\nThis hash will have one key for each field with errors. Each field will have an array of human readable error messages, as shown below:\n\n```\n{\n \"errors\": {\n \"name\": [\n \"can't be blank\"\n ],\n \"meter_unit\": [\n \"can't be blank\",\n \"is not a valid value. Please specify one of the predefined values for this field.\"\n ]\n }\n}\n```", "5-2": "", "7-0": "500 Internal Server Error", "7-1": "Ideally you should never see this, but if you do, you've probably found a bug. Yes it's true, we make bugs too. We have automated monitoring of these errors, and we try to fix them proactively, but if its a problem and its messing up your day, please [tell us about it](https://help.fleetio.com/hc/en-us/requests/new). It is also possible that our servers are down, so be sure to check out our [System Status](https://status.fleetio.com/) page for information about our servers and their current health.", "7-2": "", "6-0": "429 Too Many Requests", "6-2": "", "6-1": "The Fleetio API implements a simple throttle of 20 requests per minute. Exceeding this limit will result in this response code. The response body will be \"Too many requests detected from your IP. Please try again later. If you believe this is an error, please contact Fleetio Support at [email protected]\". The response will also include a `Retry-After` header whose value represents the number of seconds until the rate limit has been lifted. For example, `Retry-After: 60` means that you need to wait 60 seconds before making another request to the Fleetio API.", "h-0": "Status Code", "h-2": "", "h-1": "Description" }, "cols": 2, "rows": 8 } [/block]