{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/faults","auth":"required","examples":{"codes":[]},"method":"post","settings":"","results":{"codes":[{"language":"json","status":201,"name":"","code":"{  \n  \"id\":3,\n  \"name\":\"Low Tire Pressure\",\n  \"description\":null,\n  \"code\":\"P0447\",\n  \"count\":5,\n  \"account_id\":100,\n  \"vehicle_id\":200,\n  \"created_at\":\"2015-09-30T14:48:08.199-05:00\",\n  \"updated_at\":\"2015-09-30T14:48:08.199-05:00\",\n  \"external_id\":null,\n  \"last_occurred_at\":\"2015-09-09T21:43:38.726-05:00\",\n  \"status\":\"open\",\n  \"source\":\"API\"\n}"},{"name":"","code":"{\n  errors: []\n}","language":"json","status":422}]},"params":[{"name":"code","type":"string","default":"","desc":"The diagnostic trouble code. Ex. \"SPN-5444\"","required":true,"in":"body","ref":"","_id":"5654c59c9b2775210039d51f"},{"name":"count","type":"int","default":"","desc":"The number of times this alert has been triggered","required":false,"in":"body","ref":"","_id":"5654c59c9b2775210039d51e"},{"name":"description","type":"string","default":"","desc":"A short description about the problem. Ex. \"Engine Crankcase Breather Oil Separator Speed\"","required":false,"in":"body","ref":"","_id":"5654c59c9b2775210039d51d"},{"name":"external_id","type":"string","default":"","desc":"An id for external systems that this fault might also be stored in, such as the primary key of its entry in your database. Ex. \"54419\"","required":false,"in":"body","ref":"","_id":"5654c59c9b2775210039d51c"},{"name":"last_occurred_at","type":"string","default":"","desc":"Last time the alert was triggered","required":false,"in":"body","ref":"","_id":"5654c59c9b2775210039d51b"},{"name":"name","type":"string","default":"","desc":"A short name for the alert","required":false,"in":"body","ref":"","_id":"5654c59c9b2775210039d51a"},{"name":"status","type":"string","default":"open","desc":"Possible values are: \"open\", \"pending\", \"resolved\", \"ignored\"","required":true,"in":"body","ref":"","_id":"5654c59c9b2775210039d519"},{"name":"vehicle_id","type":"string","default":"","desc":"The Fleetio id for the vehicle this fault occurred on.","required":true,"in":"body","ref":"","_id":"5654c59c9b2775210039d518"},{"name":"source","type":"string","default":"API","desc":"Who reported the fault? Ex. \"Geotab\"","required":false,"in":"body","ref":"","_id":"5b8ebe75f8dd7c0003385f5b"}]},"next":{"description":"","pages":[]},"title":"/faults","type":"endpoint","slug":"create-fault","excerpt":"Creates a new fault.","body":"","updates":[],"order":6,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5abd55d3c7dcb40012bc654a","project":"54c0e51215af820d001a38a6","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"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":39},"category":{"sync":{"isSync":false,"url":""},"pages":["5654c4422870f22100fee0f4","5654c59c9b2775210039d517","5654c5c28a26202b00c17cc1","5654c5e663c6f42100db798c","5654c62038859b0d00f2568d"],"title":"Faults","slug":"dtc-alerts","order":12,"from_sync":false,"reference":true,"_id":"5654c3378a26202b00c17cb8","__v":5,"createdAt":"2015-11-24T20:06:15.417Z","project":"54c0e51215af820d001a38a6","version":"54f8de4e4339bb1900c8bffb"},"user":"5a70f375308ac0003288290d","createdAt":"2018-03-29T21:08:35.998Z","githubsync":"","__v":8,"parentDoc":null}

post/faults

Creates a new fault.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

code:
required
string
The diagnostic trouble code. Ex. "SPN-5444"
count:
integer
The number of times this alert has been triggered
description:
string
A short description about the problem. Ex. "Engine Crankcase Breather Oil Separator Speed"
external_id:
string
An id for external systems that this fault might also be stored in, such as the primary key of its entry in your database. Ex. "54419"
last_occurred_at:
string
Last time the alert was triggered
name:
string
A short name for the alert
status:
required
stringopen
Possible values are: "open", "pending", "resolved", "ignored"
vehicle_id:
required
string
The Fleetio id for the vehicle this fault occurred on.
source:
stringAPI
Who reported the fault? Ex. "Geotab"

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}