{"_id":"5aea02e9ce3de500039f3349","project":"54c0e51215af820d001a38a6","version":{"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","forked_from":"54f8de14c6cabe23005c02a2","__v":33,"createdAt":"2015-03-05T22:53:02.044Z","releaseDate":"2015-03-05T22:53:02.044Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"54f8de4e4339bb1900c8bffc","__v":1,"pages":["54f8de4f4339bb1900c8c010","54f8de4f4339bb1900c8c011","54f8de4f4339bb1900c8c012","54f8de4f4339bb1900c8c013"],"project":"54c0e51215af820d001a38a6","version":"54f8de4e4339bb1900c8bffb","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-22T11:54:59.216Z","from_sync":false,"order":0,"slug":"fleetio-api","title":"Fleetio API"},"user":"5a70f375308ac0003288290d","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-05-02T18:26:49.931Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"The Fleetio API uses standard conventions for its architecture:\n\n- API Base URL: **https://secure.fleetio.com/api/v1/**\n- All API access is over **HTTPS**\n- All data is sent and received as **JSON**\n\n\n## Endpoints and Actions\n\nMost resources follow the same format, exposing 5 actions, ``index``, ``create``, ``show``, ``update``, and ``delete``. Each action will require that the correct ``http verb`` be specified, as a single endpoint can perform different actions depending on the verb.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Action\",\n    \"h-1\": \"Endpoint\",\n    \"h-2\": \"HTTP Verb\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Response Data Type\",\n    \"0-0\": \"Index\",\n    \"1-0\": \"Create\",\n    \"2-0\": \"Show\",\n    \"3-0\": \"Update\",\n    \"4-0\": \"Delete\",\n    \"0-1\": \"/vehicles\",\n    \"0-2\": \"GET\",\n    \"1-2\": \"POST\",\n    \"2-2\": \"GET\",\n    \"3-2\": \"PATCH\",\n    \"4-2\": \"DELETE\",\n    \"1-1\": \"/vehicles\",\n    \"2-1\": \"/vehicles/:id\",\n    \"3-1\": \"/vehicles/:id\",\n    \"4-1\": \"/vehicles/:id\",\n    \"0-3\": \"Returns an array of all vehicles.\",\n    \"1-3\": \"Creates a new vehicle.\",\n    \"2-3\": \"Returns the vehicle corresponding to the id parameter.\",\n    \"3-3\": \"Updates the vehicle corresponding to the id parameter.\",\n    \"4-3\": \"Deletes the vehicle corresponding to the id parameter.\",\n    \"0-4\": \"Array\",\n    \"1-4\": \"No content\",\n    \"2-4\": \"Hash\",\n    \"3-4\": \"No content\",\n    \"4-4\": \"No content\"\n  },\n  \"cols\": 5,\n  \"rows\": 5\n}\n[/block]\n## Response Codes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200\",\n    \"1-0\": \"201\",\n    \"2-0\": \"204\",\n    \"3-0\": \"401\",\n    \"4-0\": \"403\",\n    \"5-0\": \"422\",\n    \"6-0\": \"500\",\n    \"0-1\": \"OK\",\n    \"1-1\": \"Created\",\n    \"2-1\": \"No Content\",\n    \"3-1\": \"Unauthorized\",\n    \"4-1\": \"Forbidden\",\n    \"5-1\": \"Unprocessable Entity\",\n    \"6-1\": \"Internal Server Error\",\n    \"0-2\": \"Everything went as expected! Used on ``index`` and ``show`` actions.\",\n    \"1-2\": \"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    \"2-2\": \"Denotes that an action was successful, but the API does not need to return any data. Used on ``update`` and ``delete`` actions\",\n    \"3-2\": \"Your API key or Account token is invalid. Make sure that both are specified correctly as described in the ``Authentication`` section.\",\n    \"4-2\": \"You are trying to access an endpoint for which you do not have permissions to. Check that the endpoint is correct and that your user has the necessary permissions to perform the action.\",\n    \"5-2\": \"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    \"6-2\": \"Ideally you should never see this. If you do that means that we are either having some downtime or you found a bug. If the problem persists just let one of us know and we'll get right on it!\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"schema","type":"basic","title":"Schema"}
The Fleetio API uses standard conventions for its architecture: - API Base URL: **https://secure.fleetio.com/api/v1/** - All API access is over **HTTPS** - All data is sent and received as **JSON** ## Endpoints and Actions Most resources follow the same format, exposing 5 actions, ``index``, ``create``, ``show``, ``update``, and ``delete``. Each action will require that the correct ``http verb`` be specified, as a single endpoint can perform different actions depending on the verb. [block:parameters] { "data": { "h-0": "Action", "h-1": "Endpoint", "h-2": "HTTP Verb", "h-3": "Description", "h-4": "Response Data Type", "0-0": "Index", "1-0": "Create", "2-0": "Show", "3-0": "Update", "4-0": "Delete", "0-1": "/vehicles", "0-2": "GET", "1-2": "POST", "2-2": "GET", "3-2": "PATCH", "4-2": "DELETE", "1-1": "/vehicles", "2-1": "/vehicles/:id", "3-1": "/vehicles/:id", "4-1": "/vehicles/:id", "0-3": "Returns an array of all vehicles.", "1-3": "Creates a new vehicle.", "2-3": "Returns the vehicle corresponding to the id parameter.", "3-3": "Updates the vehicle corresponding to the id parameter.", "4-3": "Deletes the vehicle corresponding to the id parameter.", "0-4": "Array", "1-4": "No content", "2-4": "Hash", "3-4": "No content", "4-4": "No content" }, "cols": 5, "rows": 5 } [/block] ## Response Codes [block:parameters] { "data": { "h-0": "Code", "h-1": "Name", "h-2": "Description", "0-0": "200", "1-0": "201", "2-0": "204", "3-0": "401", "4-0": "403", "5-0": "422", "6-0": "500", "0-1": "OK", "1-1": "Created", "2-1": "No Content", "3-1": "Unauthorized", "4-1": "Forbidden", "5-1": "Unprocessable Entity", "6-1": "Internal Server Error", "0-2": "Everything went as expected! Used on ``index`` and ``show`` actions.", "1-2": "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.", "2-2": "Denotes that an action was successful, but the API does not need to return any data. Used on ``update`` and ``delete`` actions", "3-2": "Your API key or Account token is invalid. Make sure that both are specified correctly as described in the ``Authentication`` section.", "4-2": "You are trying to access an endpoint for which you do not have permissions to. Check that the endpoint is correct and that your user has the necessary permissions to perform the action.", "5-2": "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.", "6-2": "Ideally you should never see this. If you do that means that we are either having some downtime or you found a bug. If the problem persists just let one of us know and we'll get right on it!" }, "cols": 3, "rows": 7 } [/block]