{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/fleet/pairvehicle.json","auth":"required","settings":"559288b86bf22f170075b794","examples":{"codes":[]},"method":"post","params":[{"name":"vehicleId","type":"string","default":"","desc":"ID of the vehicle (Required in the API call in case of Manual Pairing)","required":false,"in":"query","ref":"","_id":"59f842f3e84fef001c2e3f39"},{"name":"deviceSerialNum","type":"string","default":"","desc":"Serial Number of the device (Required in the API call in case of Bluetooth Pairing)","required":false,"in":"query","ref":"","_id":"59f842f3e84fef001c2e3f38"},{"name":"isUnPair","type":"boolean","default":"0","desc":"Boolean to indicate whether the vehicle is paired or unpaired","required":true,"in":"query","ref":"","_id":"59f842f3e84fef001c2e3f37"},{"name":"eventTime","type":"string","default":"","desc":"Timestamp at which the vehicle was paired or unpaired","required":true,"in":"query","ref":"","_id":"59f842f3e84fef001c2e3f36"}],"results":{"codes":[{"status":200,"name":"","code":"{  \n   \"vehiclePairInfoFeed\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAtInMillis\":1451386056073,\n      \"vehicleId\":\"4375899f-4130-11e5-b155-a1e00593e7be\",\n      \"make\":\"BMW\",\n      \"model\":\"Mini Cooper\",\n      \"year\":2014,\n      \"serialNumber\":\"5022477210\",\n      \"vin\":\"1NXBU4EE7AZ374121\",\n      \"vehicleName\":\"Joe Mini Cooper\",\n      \"vehicleType\":1,\n      \"licensePlateNum\":\"501 ACD\"\n   }\n}","language":"json"}]}},"next":{"description":"","pages":[]},"title":"Pair Vehicle","type":"endpoint","slug":"vehicle-pair","excerpt":"Use this API to pair with a vehicle. There are two ways in which you can pair with a vehicle - manual pairing and bluetooth pairing. For manual pairing, the vehicle ID has to be passed as a parameter while calling the API. And for bluetooth pairing, the device serial number has to be passed as a parameter while calling the API. isUnPair value should be set to 0 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=4375899f-4130-11e5-b155-a1e00593e7be\\n\\nUsing Device Serial Number : \\nhttps://api.azuga.com/azuga-ws/v1/fleet/pairvehicle.json?deviceSerialNum=5022477210\"\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  \"title\": \"Disclaimer\",\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}\n[/block]","updates":[],"order":14,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5641b8dc03881c0d00ac217c","parentDoc":null,"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":"55926c39cf9cdb2100b57022","editedParams2":true,"githubsync":"","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"},"createdAt":"2015-11-10T09:29:00.379Z","editedParams":true,"__v":3,"project":"55926c913735880d005f7c65"}