{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/device/view.json","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"serialNum","type":"string","default":"","desc":"Serial number of the device","required":false,"in":"body","ref":"","_id":"579b02f02b865e17005a435e"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"deviceResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":null,\n      \"generatedAt\":\"Jul-27-2016, 05:31 AM UTC\",\n      \"result\":[  \n         {  \n            \"offset\":330,\n            \"deviceId\":\"181ce1cc-8455-11e4-9bce-6d18a52c96d2\",\n            \"deviceSerialNumber\":\"9898989263\",\n            \"imei\":\"353705060403604\",\n            \"simNumber\":\"89914500040279429085\",\n            \"simPhoneNumber\":4084804499,\n            \"carrier\":\"ATT\",\n            \"productCode\":\"DL750-106\",\n            \"description\":\"Route B Tracker\",\n            \"customerId\":2175,\n            \"firmwareVersion\":\"07.28\",\n            \"configVersion\":\"TZ.60\",\n            \"activationDate\":1418655853000,\n            \"lastContactDate\":1464181354000,\n            \"vehicleProtocolVersion\":20,\n            \"vehicleName\":\"Ben’s Car\",\n            \"vehicleId\":\"181ce1cc-8455-11e4-9bce-814ecc7a2c6e\",\n            \"vehicleProtocolName\":\"OBD\"\n         },\n         {  \n            \"offset\":480,\n            \"deviceId\":\"179de4cf-8050-12d5-8bde-3d58c52d77d3\",\n            \"deviceSerialNumber\":\"4855787251\",\n            \"imei\":\"7845505099413667\",\n            \"simNumber\":\"78391048209948173745\",\n            \"simPhoneNumber\":4084807866,\n            \"carrier\":\"ATT\",\n            \"productCode\":\"DL750-235\",\n            \"description\":\"Company device\",\n            \"customerId\":3190,\n            \"firmwareVersion\":\"07.28\",\n            \"configVersion\":\"TZ.60\",\n            \"activationDate\":1467261901000,\n            \"lastContactDate\":1467442222000,\n            \"vehicleProtocolVersion\":20,\n            \"vehicleName\":\"Jane’s Office Car\",\n            \"vehicleId\":\"287da1dc-6445-21d3-8abc-624ace8a3b2d\",\n            \"vehicleProtocolName\":\"OBD\"\n         }\n      ]\n   }\n}\n}","name":""}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-1","excerpt":"This API provides you with information of all the devices present in your account. You can also get details of a particular device by passing its serial number as a parameter.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/device/view.json?\"\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    \"0-1\": \"API status code\",\n    \"1-0\": \"message\",\n    \"1-1\": \"API Message (Success/Failure)\",\n    \"2-0\": \"reason\",\n    \"2-1\": \"Reason for failure\",\n    \"3-0\": \"generatedAt\",\n    \"3-1\": \"API generation timestamp in UTC\",\n    \"4-0\": \"offset\",\n    \"4-1\": \"Time offset in minutes\",\n    \"5-0\": \"deviceId\",\n    \"5-1\": \"Unique identifier of the device\",\n    \"6-0\": \"deviceSerialNumber\",\n    \"6-1\": \"Serial number of the device\",\n    \"7-0\": \"imei\",\n    \"7-1\": \"IMEI number of the device\",\n    \"8-0\": \"simNumber\",\n    \"8-1\": \"Serial number of the SIM present in the device\",\n    \"9-0\": \"simPhoneNumber\",\n    \"9-1\": \"Phone number of the SIM present in the device\",\n    \"10-0\": \"carrier\",\n    \"10-1\": \"Network provider\",\n    \"11-0\": \"productCode\",\n    \"11-1\": \"Product code of the device\",\n    \"12-0\": \"description\",\n    \"12-1\": \"Description of the device\",\n    \"13-0\": \"customerId\",\n    \"13-1\": \"Unique identifier of the customer\",\n    \"14-0\": \"firmwareVersion\",\n    \"14-1\": \"Version of the firmware installed in the device\",\n    \"15-0\": \"configVersion\",\n    \"15-1\": \"Configuration version of the device\",\n    \"16-0\": \"activationDate\",\n    \"16-1\": \"Timestamp in milliseconds when the device was activated\",\n    \"17-0\": \"lastContactDate\",\n    \"17-1\": \"Timestamp in milliseconds when the device last communicated with the server\",\n    \"18-0\": \"vehicleProtocolVersion\",\n    \"18-1\": \"Indicates if the vehicle uses OBD or JBUS protocol for communication\",\n    \"19-0\": \"vehicleName\",\n    \"19-1\": \"Name of the vehicle\",\n    \"20-0\": \"vehicleId\",\n    \"20-1\": \"Unique identifier of the vehicle\",\n    \"21-0\": \"vehicleProtocolName\",\n    \"21-1\": \"Name of the communication protocol used by the vehicle\"\n  },\n  \"cols\": 2,\n  \"rows\": 22\n}\n[/block]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"579b02f02b865e17005a435d","project":"55926c913735880d005f7c65","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"DEVICES","slug":"devices","order":6,"from_sync":false,"reference":true,"_id":"579af3982b865e17005a4357","project":"55926c913735880d005f7c65","createdAt":"2016-07-29T06:11:36.456Z","version":"559286c6c39c4b2d00127a71","__v":0},"githubsync":"","createdAt":"2016-07-29T07:17:04.335Z","parentDoc":null,"__v":0,"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"},"user":"5656a3dd5656350d001d83a0"}

getView

This API provides you with information of all the devices present in your account. You can also get details of a particular device by passing its serial number as a parameter.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

serialNum:
string
Serial number of the device

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/device/view.json?" } [/block] ##API Response Explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "0-1": "API status code", "1-0": "message", "1-1": "API Message (Success/Failure)", "2-0": "reason", "2-1": "Reason for failure", "3-0": "generatedAt", "3-1": "API generation timestamp in UTC", "4-0": "offset", "4-1": "Time offset in minutes", "5-0": "deviceId", "5-1": "Unique identifier of the device", "6-0": "deviceSerialNumber", "6-1": "Serial number of the device", "7-0": "imei", "7-1": "IMEI number of the device", "8-0": "simNumber", "8-1": "Serial number of the SIM present in the device", "9-0": "simPhoneNumber", "9-1": "Phone number of the SIM present in the device", "10-0": "carrier", "10-1": "Network provider", "11-0": "productCode", "11-1": "Product code of the device", "12-0": "description", "12-1": "Description of the device", "13-0": "customerId", "13-1": "Unique identifier of the customer", "14-0": "firmwareVersion", "14-1": "Version of the firmware installed in the device", "15-0": "configVersion", "15-1": "Configuration version of the device", "16-0": "activationDate", "16-1": "Timestamp in milliseconds when the device was activated", "17-0": "lastContactDate", "17-1": "Timestamp in milliseconds when the device last communicated with the server", "18-0": "vehicleProtocolVersion", "18-1": "Indicates if the vehicle uses OBD or JBUS protocol for communication", "19-0": "vehicleName", "19-1": "Name of the vehicle", "20-0": "vehicleId", "20-1": "Unique identifier of the vehicle", "21-0": "vehicleProtocolName", "21-1": "Name of the communication protocol used by the vehicle" }, "cols": 2, "rows": 22 } [/block]

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 }}