Get Affected Bins and Routes Taken on Specific Route/Schedule (for Preview Only) and Execution List API
Require Authentication
This API is used to get affected bins and routes taken on specific route/schedule (for preview only) and execution list for the company based on combination of deviceID and token.
URL
api/routes/pins
Required parameter (POST)
- deviceID
- token
- maintenanceScheduleID «contains maintenanceScheduleID. Value must exist in database. To get available maintenanceScheduleID, please visit Get Available Routes/Schedules»
Optional parameter
- maintenanceScheduleProcessID «contains maintenanceScheduleProcessID. If it is not passed, this API will return routes for PREVIEW only, not the actual/processed one. If passed, value must exist in database. To get available maintenancescheduleprocessID, please visit Get Route/Schedule Execution List»
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "c43fa596e7916827106b591e2bb026cd",
"maintenanceScheduleID": 2489,
}
Possible return HTTP status code
- 200
- 400
- 401
- 404
- 405
Return message
{
"status": "success",
"message": {
"scheduleprocess": {
"maintenanceScheduleProcessID": 5934,
"estimateDurationSeconds": 2873,
"estimateDistanceMeters": 13861,
"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@?@?l@@d@@R@\\?X?N?",
"pnqd@_b{jSAO?E?QAi@Ak@C{@AOA[Ci@?C?GCw@AiA?EEo@",
"rmqd@sp{jSx@I",
"loqd@}p{jSt@Gx@GTCJA@?^?",
"`uqd@sq{jS?z@",
"`uqd@wo{jS?{@",
"`uqd@sq{jSFA`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",
"|yqd@sv{jSz@A",
"x{qd@uv{jSC_A@g@Dg@Jo@JYDO",
"z|qd@_~{jS{@@o@?u@@a@?_A@s@@[?sD@UAM?iBDK?a@@U?c@@O@oAFw@Bo@Dk@FmCVy@Cc@B",
"|upd@y{{jSAOY_CE_@CSCa@CQGo@AIQsB?EAaACWEa@CQC]EYCKCOGW?CCICSEWAO?K?W@U",
"zqpd@cu|jSQEOCKA]?Y?G@E@E@WH",
"hmpd@_u|jSAUAm@A}@AQ?]As@Ae@AoAAm@CaE?UEsDFsF",
"vlpd@iu}jSE@m@J}@Li@Ju@HSBM@c@FK@[Bk@Ji@HSBM@QDe@Nk@Fo@J_@FKB_BVk@Hc@FMD",
"`sod@ao}jSOAG?EAEACA",
"xqod@io}jSCI?A?C?A@C?A@A?A@CBA@EBE?I",
"drod@aq}jSLAVEXEx@Kh@I~@OrASz@MPEVELAZGLCJA\\Gd@GFAHA",
"|cpd@gu}jSIw@Ei@KeAEi@Iy@IaASiC?EGk@CW?IASIcAC[MaBCWAWAIEg@CYGq@AWOsBGkAAAAQAE?GCS?EI}@IcAGi@CYCa@Ce@QmBK_BCSK_BQ{AAKGe@EY",
"rzod@cs_kSTEj@GLC~@KBAhAE^Gd@Gl@GLCrBUbBMT?P?TB@?V@ZA",
"~opd@ev_kSCu@A[IiDAc@Eu@Ek@CMCMCGEGECEGAACEAEEa@CQGc@",
"hmpd@eg`kSIq@Mo@",
"plpd@gj`kSGOCIGIC?CCCAAAACACCEAA?AEOEMAI?A?A?E",
"vjpd@wm`kSOBM@G@G?K?I?MAWAGAG?KA_@EA?",
"nepd@}m`kSGCKEGCSOCCa@WECw@WUKGHADCBABCBCBCBC@A?A@A?C?CAy@OiAY",
"rzod@cq`kSs@vAUl@INCFMZAHAF?D?D@\\LnAF`@^|DZ~CDd@D`@^jDBX@DFn@\\nEJnAFt@HdA@JFz@Dh@BZDb@B^PnBJtABh@LpA@VF|@Dn@Dl@BXF~@HlADZBZBh@F`@@FHhABb@BVB`@Fl@Fn@Hn@R|A@HFv@",
"rdpd@ku}jSNENEDArAU\\El@Ib@EDAlASRCHApASp@KXE^EHAFAf@GD?^Gv@M^ERCXE`AK^GJA`@GtEs@TEPCfAO|ASf@EdAOlAQr@IpCa@xDg@TAXGVGVCVGLAh@Kh@KNAXCRCPEFATCPCh@ILCl@Ih@IPAdAOLCdAOPC\\EHAZGfAQXGZEtBYTC^G~@KXCf@ChAMd@E\\ELCfBWnAURAZI",
"~psd@{m~jSJEj@MHCPEf@IxIiA^I@?LCFADANEFCFALGDARMPKNK\\WLOT[Xq@FUDO@E@EBM@KBI?I",
"thtd@qz~jS\\IHI@A@A@A@A@?BA@ADABAHAFAL?FA@?DAF?F?V?\\BrB@lAB|@?rB@Z?X@VA",
"n|td@q{~jSJB",
"z|td@m{~jSAbAUBq@?o@AaA?U?uBEa@?WA]?W?S?MAK?SAMBMBIBG@GBE@C@EBC@CBC@A@C@C@ON",
"titd@{w~jSC@ABAFAH?@AL?J",
"hitd@gv~jSCDADAFCHARCLALENCJEFCFGFIFEDKFKDKBGBC@K@IBG@C@C@E?q@Du@Lg@H}AR}@JK@i@Fu@JaAL",
"rusd@qm~jS]DE?YDOFIFYJMFKBKDYFg@FYBi@HqC`@_@FWBkANSDm@HUDW@",
"n`sd@ch~jSDh@Dj@LbB@HD^B`@B`@N|A?J^|DNtAHx@?FH|@?FFl@?B@PBJ@`@Bj@?^@X?PBfB@PBxA",
"lesd@w`}jS@Z@l@B~@F|ADrAH|BDp@@d@Bl@@d@",
"zfsd@qm|jSjAGZAZAv@CnAEv@EfAG",
"fssd@un|jS?x@_CJw@DOBS@o@B}BJY@sA?}@E",
"pasd@wk|jS}FKgCC",
"jurd@gl|jS?\\@dA",
"lurd@ci|jSnABvBDzA@",
"p~rd@wh|jS@f@"
],
"mapDirection": [
[
{
"distance": 178,
"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.1567284
},
{
"distance": 32,
"htmlInstructions": "Turn right onto Jl. Duri Selatan IDestination will be on the left",
"longitude": 106.8060229,
"latitude": -6.1565824
}
],
[
{
"distance": 101,
"htmlInstructions": "Head south on Jl. Duri Selatan I toward Jl. Duri Selatan I C",
"longitude": 106.8060654,
"latitude": -6.1568706
},
{
"distance": 33,
"htmlInstructions": "Turn right to stay on Jl. Duri Selatan I",
"longitude": 106.8061833,
"latitude": -6.1577701
}
],
[
{
"distance": 33,
"htmlInstructions": "Head east on Jl. Duri Selatan I",
"longitude": 106.8058849,
"latitude": -6.1577694
},
{
"distance": 46,
"htmlInstructions": "Turn right to stay on Jl. Duri Selatan I",
"longitude": 106.8061833,
"latitude": -6.1577701
},
{
"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": 11,
"htmlInstructions": "Turn right onto Jl. Duri Selatan III Gg. IV",
"longitude": 106.807078,
"latitude": -6.1585317
},
{
"distance": 34,
"htmlInstructions": "Turn left onto Jl. Duri Selatan IV",
"longitude": 106.8069834,
"latitude": -6.1585459
},
{
"distance": 132,
"htmlInstructions": "Turn left at the 1st cross street onto Jl. Duri Selatan III Gg. III",
"longitude": 106.8069934,
"latitude": -6.1588487
},
{
"distance": 695,
"htmlInstructions": "Turn left onto Jl. KH.Moh.MansyurPass by Dapur Hijau 123 Nasi Uduk & Ayam Goreng Kalasan (on the left)",
"longitude": 106.8081584,
"latitude": -6.1590164
},
{
"distance": 454,
"htmlInstructions": "Turn right onto Jl. Tanah Sereal XVIII",
"longitude": 106.8078149,
"latitude": -6.1527863
},
{
"distance": 84,
"htmlInstructions": "Turn left onto Jl. Tanah Sereal Raya",
"longitude": 106.8118596,
"latitude": -6.1521352
},
{
"distance": 571,
"htmlInstructions": "Turn right onto Jl. KeamananPass by Mich-Mich Shop (on the right)",
"longitude": 106.811843,
"latitude": -6.1514062
},
{
"distance": 471,
"htmlInstructions": "Turn left onto Jl. Gajah MadaPass by Indomaret Gajahmada 2 (on the left)",
"longitude": 106.817007,
"latitude": -6.1513216
},
{
"distance": 23,
"htmlInstructions": "Slight right toward Jl. Hayam Wuruk",
"longitude": 106.8160139,
"latitude": -6.147207
},
{
"distance": 34,
"htmlInstructions": "Turn right toward Jl. Hayam Wuruk",
"longitude": 106.8160472,
"latitude": -6.1470073
},
{
"distance": 324,
"htmlInstructions": "Turn right onto Jl. Hayam WurukPass by Sinar Matahari Elektrik (PT Pacific Unidinamika International) (on the left)",
"longitude": 106.8163257,
"latitude": -6.147068
},
{
"distance": 1108,
"htmlInstructions": "Turn left onto Jl. Raya Mangga Besar (signs for Gn. Sahari/
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.