{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/fleet/pairvehicle.json","auth":"required","examples":{"codes":[]},"method":"post","params":[{"name":"vehicleId","type":"string","default":"","desc":"Unique identifier representing the vehicle (Required in the API call in case of Manual pairing)","required":false,"in":"body","ref":"","_id":"5641c1939417b40d00c0fbf3"},{"name":"deviceSerialNum","type":"string","default":"","desc":"Serial number of the device (Required in the API call in case of Bluetooth pairing)","required":false,"in":"body","ref":"","_id":"5641c1939417b40d00c0fbf2"},{"name":"isUnPair","type":"boolean","default":"1","desc":"Boolean to indicate if the vehicle is paired or unpaired","required":true,"in":"body","ref":"","_id":"5641c1939417b40d00c0fbf1"},{"name":"eventTime","type":"string","default":"","desc":"Time at which the vehicle was paired or unpaired","required":true,"in":"body","ref":"","_id":"5641c1939417b40d00c0fbf0"}],"results":{"codes":[{"name":"","code":"{ \n \"vehiclePairInfoFeed\":{ \n \"code\":200,\n \"message\":\"Success\",\n \"reason\":\"\",\n \"generatedAtInMillis\":1451386144299,\n \"vehicleId\":\"43b5ed46-4130-11e5-9747-67ddc16ee6d5\",\n \"make\":null,\n \"model\":null,\n \"year\":null\n \"serialNumber\":null,\n \"vin\":null,\n \"vehicleName\":null,\n \"vehicleType\":null,\n \"licensePlateNum\":null\n }\n}","language":"json","status":200}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"Unpair Vehicle","type":"endpoint","slug":"unpair-vehicle","excerpt":"Use this API to unpair with a vehicle. You can unpair either using the vehicle ID (in case of manual pairing) or device serial number (in case of bluetooth pairing). isUnPair value should be set to 1 while calling this API.","body":"[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Sample Request\",\n \"body\": \"Using Vehicle ID : \\nhttps://api.azuga.com/azuga-ws/v1/fleet/pairvehicle.json?vehicleId=43b5ed46-4130-11e5-9747-67ddc16ee6d5&isUnPair=true\\n\\nUsing Device Serial Number : \\nhttps://api.azuga.com/azuga-ws/v1/fleet/pairvehicle.json?deviceSerialNum=5022477210&isUnPair=true\"\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 \"2-0\": \"reason\",\n \"3-0\": \"generatedAtInMillis\",\n \"0-1\": \"API Status Code\",\n \"1-1\": \"API Message\",\n \"2-1\": \"Reason for failure\",\n \"3-1\": \"API generation timestamp in milliseconds\",\n \"4-0\": \"vehicleId\",\n \"5-0\": \"make\",\n \"6-0\": \"model\",\n \"7-0\": \"year\",\n \"8-0\": \"serialNumber\",\n \"9-0\": \"vin\",\n \"10-0\": \"vehicleName\",\n \"11-0\": \"vehicleType\",\n \"12-0\": \"licensePlateNum\",\n \"4-1\": \"Unique identifier representing the vehicle\",\n \"5-1\": \"Make of the vehicle\",\n \"6-1\": \"Model of the vehicle\",\n \"7-1\": \"Year in which the vehicle was manufactured\",\n \"8-1\": \"Serial Number of the device\",\n \"9-1\": \"Vehicle Identification Number\",\n \"10-1\": \"Name of the vehicle\",\n \"11-1\": \"Type of the vehicle\",\n \"12-1\": \"License plate number of the vehicle\"\n },\n \"cols\": 2,\n \"rows\": 13\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"body\": \"This API provides information only for a driver and does not provide aggregated information for a group of vehicles. Admins should not use these APIs, but should look at other sections of the documentation.\",\n \"title\": \"Disclaimer\"\n}\n[/block]","updates":[],"order":15,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5641c06238e37e0d0049fe6b","editedParams":true,"editedParams2":true,"parentDoc":null,"__v":3,"category":{"sync":{"isSync":false,"url":""},"pages":["55928fd16bf22f170075b7b4","5592bd5a6bf22f170075b851","56416d6803881c0d00ac214b","5641702a03881c0d00ac214d","56417262b0dc090d00f88396","5641748f9f4ed50d008be04d","56417a76f424a10d00118215","56417c7b9417b40d00c0fbc6","56417f7f9417b40d00c0fbca","5641803203881c0d00ac2153","5641842903881c0d00ac2155","56418c259f4ed50d008be062","56418e30b0dc090d00f883a6","564192599417b40d00c0fbd1","564195c403881c0d00ac2162","5641988502fe811900f076c3","5641b8dc03881c0d00ac217c","5641c06238e37e0d0049fe6b","5656e88da795770d00a2aee0"],"title":"MOBILE","slug":"fleet-mobile","order":1,"from_sync":false,"reference":true,"_id":"55928a98c39c4b2d00127a83","version":"559286c6c39c4b2d00127a71","project":"55926c913735880d005f7c65","__v":19,"createdAt":"2015-06-30T12:24:56.461Z"},"user":"55926c39cf9cdb2100b57022","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"},"githubsync":"","createdAt":"2015-11-10T10:01:06.821Z","project":"55926c913735880d005f7c65"}
postUnpair Vehicle
Use this API to unpair with a vehicle. You can unpair either using the vehicle ID (in case of manual pairing) or device serial number (in case of bluetooth pairing). isUnPair value should be set to 1 while calling this API.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Body Params
vehicleId:
string
Unique identifier representing the vehicle (Required in the API call in case of Manual pairing)
deviceSerialNum:
string
Serial number of the device (Required in the API call in case of Bluetooth pairing)
isUnPair:
required
boolean1
Boolean to indicate if the vehicle is paired or unpaired
eventTime:
required
string
Time at which the vehicle was paired or unpaired