{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vehicle_assignments/:id","auth":"required","method":"get","params":[{"name":"id","type":"int","default":"","desc":"","required":true,"in":"path","ref":"","_id":"554bb451f2829e19005871bc"},{"name":"include_archived","type":"string","default":"0","desc":"Flag to show a vehicle assignment even if its corresponding vehicle is archived.","required":false,"in":"query","ref":"","_id":"5bf34442be2bc30038115faa"}],"results":{"codes":[{"code":"{\n  \"id\":2,\n  \"vehicle_id\":100,\n  \"contact_id\":200,\n  \"started_at\":\"2014-08-15T16:00:00.000-05:00\",\n  \"ended_at\":\"2014-08-15T16:00:34.000-05:00\",\n  \"starting_meter_entry_value\": 13532,\n  \"ending_meter_entry_value\": 14600,\n  \"comments_count\":1,\n  \"current\":false,\n  \"future\":false,\n  \"contact_full_name\":\"Américo Williams\",\n  \"contact_image_url\":\"https://d3mgxxlx76tp6w.cloudfront.net/api/file/moT7QYByTSG4T3y4fBcA\",\n  \"custom_fields\": {\n    \"temporary_driver\":\"false\",\n    \"department_using_vehicle\":\"Baltimore\"\n  },\n  \"attachment_permissions\":{},\n  \"comments\": [\n    {\n      \"id\":841995,\n      \"title\":\"Delivery of lumber for Acme, Inc.\",\n      \"comment\":\"Needed to get Américo to handle this run because Emilio was on PTO.\",\n      \"commentable_type\":\"VehicleAssignment\",\n      \"commentable_id\":135302,\n      \"user_id\":28166,\n      \"user_full_name\":\"Koy Carryaway\",\n      \"user_image_url\":\"https://d3mgxxlx76tp6w.cloudfront.net/api/file/qJs3Qj6TEqeHSgR368XA\",\n      \"created_at\":\"2014-08-16T16:58:31.431-05:00\",\n      \"updated_at\":\"2014-08-16T16:58:31.431-05:00\"\n    }\n  ],\n  \"created_at\":\"2014-08-15T16:00:33.755-05:00\",\n  \"updated_at\":\"2014-08-15T16:00:40.319-05:00\"\n}","name":"","status":200,"language":"json"}]},"examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"/vehicle_assignments/:id","type":"endpoint","slug":"vehicle-assignment","excerpt":"Retrieves the details of an existing vehicle assignment.","body":"","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"554bb451f2829e19005871bb","createdAt":"2015-05-07T18:52:01.464Z","user":"54cba76f6d1eee0d00c33dee","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},"editedParams":true,"project":"54c0e51215af820d001a38a6","parentDoc":null,"__v":9,"category":{"sync":{"isSync":false,"url":""},"pages":["554bb377f245703100ddd3a0","554bb451f2829e19005871bb","554bb5a13ca3e00d00536f6c","554bb6003ca3e00d00536f71","554bb62cf2829e19005871c2","554bb64e3ca3e00d00536f73"],"title":"Vehicle Assignments","slug":"vehicle-assignments","order":32,"from_sync":false,"reference":true,"_id":"554bb366f245703100ddd39f","version":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","__v":6,"createdAt":"2015-05-07T18:48:06.207Z"},"editedParams2":true,"githubsync":""}

get/vehicle_assignments/:id

Retrieves the details of an existing vehicle assignment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer

Query Params

include_archived:
string0
Flag to show a vehicle assignment even if its corresponding vehicle is archived.

Result Format


User Information

Try It Out

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