Run / Execute Processed Route (Add or Update Execution Data) API
Require Authentication
This API is used to run / execute processed route (add or update execution data) to save it into a log data for the company based on combination of deviceID and token.
URL
api/routes/execution
Required parameter (POST)
- deviceID
- token
- maintenanceScheduleProcessID «contains maintenanceScheduleProcessID that will be executed. Value must exist in Get Processed Route/Schedule List»
- departureTime
- startLatitude
- startLongitude
Optional parameter (POST)
- processStatus «Possible value: 'not_started', 'in_progress', 'completed'. Default value: 'not_started'»
- completedTime
- startAddress1
- startAddress2
- startCity
- startState
- startCountry
- startPostcode
- endLatitude
- endLongitude
- endAddress1
- endAddress2
- endCity
- endState
- endCountry
- endPostcode
- driverNote
Note: If address is not specified, it will be automatically filled from Google data based on its latitude and longitude.
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "c43fa596e7916827106b591e2bb026cd",
"maintenanceScheduleProcessID": 5949,
"departureTime": 1473854400,
"startLatitude": -27.464832305908,
"startLongitude": 153.022125244141
}
Possible return HTTP status code
- 200 - if it is perform update query
- 201 - if it is perform insert query
- 400
- 401
- 404
- 405
Return message
{
"status": "success",
"message": {
"scheduleprocess": {
"maintenanceScheduleProcessID": 5949,
"maintenanceScheduleID": 2489,
"estimateDurationSeconds": 1396,
"estimateDistanceMeters": 5913,
"startLatitude": -6.154994010925,
"startLongitude": 106.80372619629,
"startAddress1": "",
"startAddress2": "",
"startCity": "",
"startState": "",
"startCountry": "",
"startPostcode": "",
"endLatitude": -6.164274215698,
"endLongitude": 106.80966949463,
"endAddress1": "",
"endAddress2": "",
"endCity": "",
"endState": "",
"endCountry": "",
"endPostcode": "",
"mapPolyline": [
"leqd@mc{jSFHBF?B?D@@BB?@?B?@D?@?D?NAH?v@?@?n@@x@B\\?Z?L?",
"rnqd@_b{jSAU?QCi@Ak@C{@GuA?E?ECy@AcA?IEo@",
"rmqd@sp{jSnBQ",
"bqqd@eq{jSx@GTCJA@?^?FA",
"huqd@uq{jS`ABH?",
"twqd@qq{jSAQ@AA[",
"rwqd@as{jS@ZA@@P",
"twqd@qq{jSfAA",
"|yqd@sq{jS?_DCS",
"xyqd@gw{jS}AH",
"zvqd@}v{jS|AI",
"xyqd@gw{jSBR?~C",
"|yqd@sq{jSgA@I?aACG@_@?A?K@UBI?",
"rrqd@mq{jSo@FoBP",
"rmqd@sp{jSGg@A[Co@AYG}BGuC",
"rlqd@u}{jS?KxAAnA?xAE`BE",
"xwqd@o~{jS?o@",
"xwqd@_`|jS?n@",
"xwqd@o~{jSN?b@Ap@@\\?RAtA@dABB?`@@f@@dBFr@Dx@BZ@N?hBA\\?zBC|AEx@CT?x@?dBEjAA",
"x`sd@k~{jSL?d@AhCED?",
"|fsd@s~{jSAMImCCcA?WCu@CcAAW?SC{@Ci@EaAAc@AUK{BGmA?ACy@?ICeAA[As@CkBGaDAk@Ac@Cy@AOEc@E[C[QgBGk@CUAM?EAGe@sEKkAGw@Em@?CEo@?UG_A",
"z_sd@sf~jSZEJbAFjA?HFv@@H?HRtB?J^|DNtAHx@?FH|@?FFl@?B@PBJ@`@Bj@?^@X?PBfB@PBxA",
"lesd@w`}jS@Z@l@B~@F|ADrAH|BDp@@d@Bl@@d@",
"zfsd@qm|jSjAGZAZAp@ClCIhAE",
"hssd@qn|jS?z@aCHgADcAD}BJY@sA?}@E",
"pasd@wk|jS}FKgCC",
"jurd@gl|jS?\\?dA",
"jurd@ci|jSjENxAB",
"p~rd@oh|jS@^"
],
"mapDirection": [
[
{
"distance": 180,
"htmlInstructions": "Head southwest on Jl. Trikora toward Jl. Duri Utara Gg. 5",
"longitude": 106.8039122,
"latitude": -6.1552746
},
{
"distance": 260,
"htmlInstructions": "Turn left onto Jl. Duri (Tss Raya)Pass by Perum Pegadaian - CPP Gang Ketapang (on the right)",
"longitude": 106.8036807,
"latitude": -6.1567446
},
{
"distance": 63,
"htmlInstructions": "Turn right onto Jl. Duri Selatan I",
"longitude": 106.8060229,
"latitude": -6.1565824
}
],
[
{
"distance": 76,
"htmlInstructions": "Head south on Jl. Duri Selatan I toward Gg. Cahaya",
"longitude": 106.8061051,
"latitude": -6.1571396
}
],
[
{
"distance": 42,
"htmlInstructions": "Head south on Jl. Duri Selatan I toward Jl. Jamblang Raya I",
"longitude": 106.8061882,
"latitude": -6.1578131
},
{
"distance": 27,
"htmlInstructions": "Turn leftDestination will be on the right",
"longitude": 106.8061701,
"latitude": -6.158187
}
],
[
{
"distance": 27,
"htmlInstructions": "Head west toward Jl. Duri Selatan I",
"longitude": 106.8064099,
"latitude": -6.1581771
},
{
"distance": 41,
"htmlInstructions": "Turn left onto Jl. Duri Selatan I",
"longitude": 106.8061701,
"latitude": -6.158187
},
{
"distance": 99,
"htmlInstructions": "Turn left onto Jl. Duri Selatan III Gg. IV",
"longitude": 106.8061832,
"latitude": -6.158552
},
{
"distance": 53,
"htmlInstructions": "Turn left onto Jl. Duri Selatan IVRestricted usage roadDestination will be on the right",
"longitude": 106.807078,
"latitude": -6.1585317
}
],
[
{
"distance": 53,
"htmlInstructions": "Head south on Jl. Duri Selatan IV toward Jl. Duri Selatan III Gg. IVRestricted usage road",
"longitude": 106.8070317,
"latitude": -6.1580615
},
{
"distance": 99,
"htmlInstructions": "Turn right onto Jl. Duri Selatan III Gg. IV",
"longitude": 106.807078,
"latitude": -6.1585317
},
{
"distance": 130,
"htmlInstructions": "Turn right onto Jl. Duri Selatan I",
"longitude": 106.8061832,
"latitude": -6.158552
}
],
[
{
"distance": 90,
"htmlInstructions": "Head north on Jl. Duri Selatan I toward Jl. Duri Selatan I C",
"longitude": 106.8061459,
"latitude": -6.1573842
},
{
"distance": 232,
"htmlInstructions": "Turn right after JNE Bromo (on the right)",
"longitude": 106.8060229,
"latitude": -6.1565824
},
{
"distance": 206,
"htmlInstructions": "Turn right after TOKO TONI KALI 2 (on the left)",
"longitude": 106.8081124,
"latitude": -6.1564176
},
{
"distance": 27,
"htmlInstructions": "Turn leftDestination will be on the left",
"longitude": 106.8082358,
"latitude": -6.1582124
}
],
[
{
"distance": 27,
"htmlInstructions": "Head west toward Jl. KH.Moh.Mansyur",
"longitude": 106.8084835,
"latitude": -6.1582118
},
{
"distance": 730,
"htmlInstructions": "Turn left onto Jl. KH.Moh.MansyurPass by WARPULL (on the right in 350m)",
"longitude": 106.8082358,
"latitude": -6.1582124
},
{
"distance": 109,
"htmlInstructions": "Continue straight onto Jl. Imam Mahbud/
Note:
IMPORTANT! latitude and longitude in mapDirection is not always exist. Old data do not have this one, but new one since 9 June 2017 has. So please be careful when processing data.
Use "mapPolyline" to draw polyline on map. "mapPolyline" is in array format, first element is from start point to first bin, second element is from first asset to next point (next asset or end point), and so on.
Use "mapDirection" to display routes based on its sequence. First element is from start point to first bin, second element is from first asset to next point (next asset or end point), and so on. Each element has its own array consist of explanation step by step.
"pins" has defaultOrder and is sorted by defaultOrder asc, it can be used to define what pins comes first, and what next.
"distance" is in meters.