{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vehicle/view.json?vehicleName=:vehicleName&groupName=:groupName","auth":"required","settings":"559288b86bf22f170075b794","examples":{"codes":[]},"method":"get","params":[{"name":"vehicleName","type":"string","default":"","desc":"Name of the vehicle (either the vehicle name, or the group name or the vehicleId is required for the API call)","required":false,"in":"query","ref":"","_id":"5631bea5bddb091700ad5df4"},{"name":"groupName","type":"string","default":"","desc":"Name of the group (either the vehicle name, or the group name or the vehicleId is required for the API call)","required":false,"in":"query","ref":"","_id":"5631bea5bddb091700ad5df3"},{"name":"vehicleIds","type":"string","default":"","desc":"Comma separated list of vehicle identifiers (either the vehicle name, or the group name or the vehicleId is required for the API call)","required":false,"in":"query","ref":"","_id":"5631bea5bddb091700ad5df0"},{"name":"page","type":"int","default":"1","desc":"Page number of the paginated result","required":false,"in":"query","ref":"","_id":"5631bea5bddb091700ad5df2"},{"name":"includeChildGroups","type":"string","default":"false","desc":"Boolean value specifying whether vehicles under the child groups need to be included in the result or not","required":false,"in":"query","ref":"","_id":"5631bea5bddb091700ad5df1"},{"name":"lastSyncTime","type":"int","default":"0","desc":"Fetch updates since timestamp in UTC milliseconds","required":false,"in":"query","ref":"","_id":"5d91b65e991a08002bead0b8"}],"results":{"codes":[{"code":"{\n \"vehicleResponseVO\": {\n \"code\": 200,\n \"message\": \"Success\",\n \"messageCode\": null,\n \"reason\": \"\",\n \"generatedAt\": \"Dec-15-2015, 06:01 PM UTC\",\n \"currentPage\": 1,\n \"totalPages\": 1,\n \"vehicles\": [\n {\n \"vehicleId\": \"ee02acb8-ac3e-11e4-90dd-e1190100e6eb\",\n \"vehicleName\": \"Ben's Vehicle\",\n \"vehicleType\": \"Car\",\n \"groupName\": \"West Coast\",\n \"make\": \"BMW\",\n \"model\": \"7 Series\",\n \"year\": 2012,\n \"vin\": \"1NXBU4EE7AZ374121\",\n \"licensePlate\": \"\",\n \"odometer\": 96,\n \"phoneNumber\": null,\n \"costPerMile\": 0.71,\n \"serialNumber\": \"8760078839\",\n \"assetNumber\": \"\",\n \"lastContactDate\": \"14-Dec-2015, 3:31 PM PST\",\n \"ownerShip\": \"\",\n \"reserved1\": null,\n \"reserved2\": null,\n \"reserved3\": null,\n \"reserved4\": null,\n \"driverId\": \"0083e577-295d-11e6-bf77-f90cdcd919f2\",\n \"lastConatctDateGMT\": 1450107104000\n }\n ]\n }\n}","name":"","status":200,"language":"json"}]}},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-vehicles","excerpt":"This API returns you with a detailed snapshot of the vehicles present in your account. Details such as odometer readings, last contact time, last location are useful in determining real-time activities across your fleet.","body":"[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Sample Request\",\n \"body\": \"https://api.azuga.com/azuga-ws/v1/vehicle/view.json?groupName=WestCoast\"\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Description\",\n \"0-0\": \"code\",\n \"1-0\": \"message\",\n \"3-0\": \"generatedAt\",\n \"4-0\": \"reason\",\n \"5-0\": \"currentPage\",\n \"6-0\": \"totalPages\",\n \"0-1\": \"API Status Code\",\n \"1-1\": \"API Message (Success/Failure)\",\n \"3-1\": \"API generation timestamp in UTC\",\n \"4-1\": \"The reason for failure\",\n \"5-1\": \"The current page\",\n \"6-1\": \"The total number of pages in the result\",\n \"7-0\": \"vehicles\",\n \"9-0\": \"vehicleName\",\n \"11-0\": \"groupName\",\n \"12-0\": \"make\",\n \"13-0\": \"model\",\n \"14-0\": \"year\",\n \"15-0\": \"vin\",\n \"16-0\": \"licensePlate\",\n \"7-1\": \"An array of vehicle objects\",\n \"9-1\": \"Name of the vehicle\",\n \"11-1\": \"Name of the group associated with the vehicle\",\n \"12-1\": \"Make of the vehicle\",\n \"13-1\": \"Model of the vehicle\",\n \"14-1\": \"Year in which the vehicle was manufactured\",\n \"15-1\": \"Vehice Identification Number\",\n \"16-1\": \"License plate number of the vehicle\",\n \"17-0\": \"odometer\",\n \"18-0\": \"phoneNumber\",\n \"19-0\": \"costPerMile\",\n \"20-0\": \"serialNumber\",\n \"21-0\": \"lastContactDate\",\n \"22-0\": \"lastConatctDateGMT\",\n \"24-0\": \"assetNumber\",\n \"17-1\": \"Odometer reading of the vehicle\",\n \"18-1\": \"Phone number of the driver\",\n \"19-1\": \"Operating cost per mile of the vehicle\",\n \"20-1\": \"Serial number of the device associated with the vehicle\",\n \"21-1\": \"Timestamp (user time zone) when the device and vehicle were last paired\",\n \"22-1\": \"Timestamp (UTC) when the device and vehicle were last paired\",\n \"25-0\": \"ownerShip\",\n \"24-1\": \"Asset number of the vehicle\",\n \"25-1\": \"Ownership type of the vehicle\",\n \"26-0\": \"reserved1\",\n \"27-0\": \"reserved2\",\n \"28-0\": \"reserved3\",\n \"29-0\": \"reserved4\",\n \"26-1\": \"Reserved variable for future use\",\n \"27-1\": \"Reserved variable for future use\",\n \"28-1\": \"Reserved variable for future use\",\n \"29-1\": \"Reserved variable for future use\",\n \"10-0\": \"vehicleType\",\n \"10-1\": \"Type of vehicle\",\n \"8-0\": \"vehicleId\",\n \"8-1\": \"Unique identifier representing the vehicle\",\n \"23-1\": \"Unique identifier representing the driver\",\n \"23-0\": \"driverId\",\n \"2-0\": \"messageCode\",\n \"2-1\": \"API sub-error code\"\n },\n \"cols\": 2,\n \"rows\": 30\n}\n[/block]","updates":["5f87843249c93200286cd02c"],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5631be58fc94aa0d00e9b5f5","__v":17,"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"VEHICLE","slug":"vehicle","order":3,"from_sync":false,"reference":true,"_id":"567923b8239fac0d00c7df25","project":"55926c913735880d005f7c65","version":"559286c6c39c4b2d00127a71","createdAt":"2015-12-22T10:19:36.628Z","__v":0},"editedParams2":true,"parentDoc":null,"project":"55926c913735880d005f7c65","user":"55926c39cf9cdb2100b57022","editedParams":true,"githubsync":"","createdAt":"2015-10-29T06:36:08.976Z"}
getView
This API returns you with a detailed snapshot of the vehicles present in your account. Details such as odometer readings, last contact time, last location are useful in determining real-time activities across your fleet.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
vehicleName:
string
Name of the vehicle (either the vehicle name, or the group name or the vehicleId is required for the API call)
groupName:
string
Name of the group (either the vehicle name, or the group name or the vehicleId is required for the API call)
vehicleIds:
string
Comma separated list of vehicle identifiers (either the vehicle name, or the group name or the vehicleId is required for the API call)
page:
integer1
Page number of the paginated result
includeChildGroups:
stringfalse
Boolean value specifying whether vehicles under the child groups need to be included in the result or not
lastSyncTime:
integer0
Fetch updates since timestamp in UTC milliseconds