Get Driver Processed GPS on Processed Route API
Require Authentication
This API is used to Get Driver Processed GPS on Processed Route for the company based on combination of deviceID and token. This will not return the GPS coordinate, but it will return the polyline to be used to be displayed in a map. That polyline is from coordinate process.
gpsfinal field will contain polyline from each user. So if there are several drivers process the route, it will have several polyline.
In website, the color code for each route are #09b89b, #2e8cf2, #e06e1d
URL
api/routes/gpsfinal
Required parameter (POST)
- deviceID
- token
- maintenanceScheduleID «contains maintenanceScheduleID. Value must exist in database. To get available maintenanceScheduleID, please visit Get Available Routes/Schedules»
- maintenanceScheduleProcessID «contains maintenanceScheduleProcessID. Value must exist in database. To get available maintenanceScheduleProcessID, please visit Get Processed Route/Schedule List»
Optional parameter
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "c43fa596e7916827106b591e2bb026cd",
"maintenanceScheduleID": 4,
"maintenanceScheduleProcessID": 1
}
Possible return HTTP status code
- 200
- 400
- 401
- 404
- 405
Return message
{
"status": "success",
"message": {
"gpsfinal": [{
"maintenanceScheduleGPSFinalID": 1,
"userID": 3,
"maintenanceScheduleProcessID": 1,
"maintenanceScheduleID": 4,
"startTime": 1482483077,
"endTime": 1482783077,
"mapPolyline": "nkzd@otvjS?gE?{BnB?",
"startLatitude": -6.202315807343,
"startLongitude": 106.78104400635,
"endLatitude": -6.202877044678,
"endLongitude": 106.78266143799,
"gpsTotal": 4,
"companyID": 1
}],
"pins": [{
"defaultOrder": 0,
"collected": "Y",
"missedReason": "",
"collectionTime": 1479824817,
"collectedBy": {
"userID": 3,
"username": "indr4_winata@yahoo.com",
"firstName": "Indra",
"lastName": "Winata"
},
"lastCollectedData": {
"ultrasound": 47,
"depthWhenEmpty_cm": 100,
"distanceSensorToFillLine_cm": 10
},
"projectpinID": 11,
"projectID": 2,
"projectName": "edited by API",
"projectgroupID": 0,
"groupName": "",
"iconType": "pintype",
"iconID": 0,
"iconURL": "http://localhost/sswebdash/assets/images/icons/numbers/appsize/08.png",
"customlocationID": 0,
"locationName": "",
"pinAddress1": "Jalan Anggrek 28C",
"pinAddress2": "",
"pinCity": "Kota Jakarta Barat",
"pinState": "Daerah Khusus Ibukota Jakarta",
"pinCountry": "ID",
"pinZipCode": "11530",
"latitude": -27.468715667725,
"longitude": 153.02775573731,
"name": "Pin Custom",
"description": "",
"serialNumber": "",
"assetTag": "",
"manufacturerID": 0,
"manufacturerName": "",
"createdDate": 1471007209,
"creatorUserID": 3,
"pinType": {
"pintypeID": 1,
"pinTypeName": "Pin Custom",
"depthWhenEmpty_cm": 0,
"distanceSensorToFillLine_cm": 0
}
}, {
"defaultOrder": 1,
"collected": "Y",
"missedReason": "",
"collectionTime": 1479824817,
"collectedBy": {
"userID": 3,
"username": "indr4_winata@yahoo.com",
"firstName": "Indra",
"lastName": "Winata"
},
"lastCollectedData": {
"ultrasound": 47,
"depthWhenEmpty_cm": 100,
"distanceSensorToFillLine_cm": 10
},
"projectpinID": 10,
"projectID": 2,
"projectName": "edited by API",
"projectgroupID": 0,
"groupName": "",
"iconType": "pintype",
"iconID": 0,
"iconURL": "http://localhost/sswebdash/assets/images/icons/numbers/appsize/08.png",
"customlocationID": 0,
"locationName": "",
"pinAddress1": "Jalan Salam 3 8",
"pinAddress2": "",
"pinCity": "Kota Jakarta Barat",
"pinState": "Daerah Khusus Ibukota Jakarta",
"pinCountry": "ID",
"pinZipCode": "11530",
"latitude": -27.479148864746,
"longitude": 153.02204895019,
"name": "Pin Custom",
"description": "",
"serialNumber": "",
"assetTag": "",
"manufacturerID": 0,
"manufacturerName": "",
"createdDate": 1471007122,
"creatorUserID": 3,
"pinType": {
"pintypeID": 1,
"pinTypeName": "Pin Custom",
"depthWhenEmpty_cm": 0,
"distanceSensorToFillLine_cm": 0
}
}]
}
}
Note:gpsfinal contains a list of map polyline per user per maintenanceScheduleProcessID per maintenanceScheduleID