文件編號：密級：普通受控編號：生效日期：總頁數(shù)：正文：附錄：編制：批準(zhǔn)：路徑規(guī)劃服務(wù)說明書北京世紀(jì)高通科技有限公司序號版次號修改條款及內(nèi)容修改人審核人批準(zhǔn)人修改日期11.0創(chuàng)建王海峰李靜茹2021.10.26引言編寫目的編寫本文檔是為了對里程樁服務(wù)接口進行說明。預(yù)期讀者為設(shè)計人員、開發(fā)人員、測試人員、維護人員、驗收人員。開發(fā)指南接口說明接口采用GET方式發(fā)送請求。狀態(tài)碼代碼返回值說明0Success算路成功1001Routingfailed.算路失敗1002RoutertooShort.路線結(jié)果過短(長度為0)1003Routetoolong.路線超長1004Memorynotenough.內(nèi)存不足1005Reroutefailed.偏航重算路失敗1006Reroutegrabfailed.根據(jù)軌跡抓路失敗1007Notoffcourse,noneedtoreroute.沒有偏離路線1008Toomanywaypoints.途經(jīng)點太多3001Networderror.網(wǎng)絡(luò)出錯。在線算路時網(wǎng)絡(luò)鏈接出錯或服務(wù)器出錯。3002Requestprotocolversionnotsupported.算路請求的版本是服務(wù)器不支持的版本3003Paramerror.算路請求參數(shù)錯誤3004PolylineCodecisnotsupportedinrequest.請求坐標(biāo)編碼不支持PolylineCodec3005Responsejsonfromateerror.收到的路線結(jié)果JSON格式錯誤3006Responseversionerror.收到的路線結(jié)果中協(xié)議版本錯誤，引擎無法正確解析4001Incomplateroutepoints路線計劃不完整:普通和探路模式需要設(shè)置起點和終點，漫游模式需要設(shè)置起點4002Failedtograborigin.起點附近沒有道路4003Failedtograbdestination.終點附近沒有道路4004Failedtograbwaypoint.途經(jīng)點附近沒有道路4005Regulationdisablebutrequired.未啟用限行，不能請求下發(fā)(供瀏覽用的)政策限行信息4009Physicalrestrictiondisabledbutrequierd未啟用物理限行但要求下發(fā)物理限行信息5001Departtimeearlierthensystemtime.預(yù)測路況請求指定的出發(fā)時間早于當(dāng)前系統(tǒng)時間5002Forecastrequestfailed.預(yù)測路況請求失敗5003Forecastrespoinsejsonformaterror.預(yù)測路況請求響應(yīng)Json格式錯誤6001Enrouteetarequestfailed.沿路ETA請求錯誤7001Requestmethodisnotsupported請求方式不支持參數(shù)定義輸出參數(shù)采用JSON格式，詳見以下接口定義。接口定義駕車路徑規(guī)劃接口地址：/service/lbs/route/v1/driving接口描述：通過起終點及途經(jīng)點，避讓區(qū)域等信息，針對不同策略，規(guī)劃出最優(yōu)行駛路線。請求參數(shù)字段名稱字段類型字段含義規(guī)則說明是否必填keystring用戶唯一標(biāo)識及鑒權(quán)id用戶在minedata官網(wǎng)或本地部署門戶申請是originstring起點經(jīng)度在前，緯度在后，經(jīng)度和緯度用","分割。是headingnumber定位方向起點的車頭方向。取值范圍：0-359否destinationstring終點經(jīng)度在前，緯度在后，經(jīng)度和緯度用","分割。是avoidpolygonsstring避讓區(qū)域區(qū)域避讓，支持32個避讓區(qū)域，每個區(qū)域最多可有16個頂點

經(jīng)度和緯度用","分割，經(jīng)度在前，緯度在后，坐標(biāo)點之間用";"分隔，區(qū)域之間用"|"分隔。如果是四邊形則有四個坐標(biāo)點，如果是五邊形則有五個坐標(biāo)點；否avoidpointsstring避讓點避讓點用lng,lat<中心坐標(biāo)>;radius<半徑/米>表達,多個避讓點之間以英文豎線|分割

最大數(shù)目：32個避讓點，半徑最大支持5千米。否waypointsstring途徑點經(jīng)度和緯度用","分割，經(jīng)度在前，緯度在后，小數(shù)點后不超過6位，坐標(biāo)點之間用";"分隔

最大數(shù)目：50個坐標(biāo)點。如果輸入多個途徑點，則按照用戶輸入的順序進行路徑規(guī)劃否strategynumber算路策略0：默認(rèn)

1：最短距離(只返回一條路線)

2：不走高速

3：高速優(yōu)先

4：少收費

5：躲避擁堵

6:躲避擁堵&高速優(yōu)先

7:躲避擁堵&不走高速

8:躲避擁堵&少收費

9:躲避擁堵&不走高速&少收費否ferrynumber是否走輪渡0:使用渡輪(默認(rèn))

1:不使用渡輪否alternativesnumber備選路線是否返回備選路線

可選值：

0:返回1條路線（默認(rèn)）

1:返回1-3條路線否cartypenumber車輛類型車輛類型（影響限行規(guī)則），取值：

0:普通汽車(默認(rèn))

1:新能源

2:插電混動車否plate_numberstring車牌號填入車牌信息，包括所在省份，字母需大寫。

用于判斷限行相關(guān)。支持6位傳統(tǒng)車牌和7位新能源車牌否linkinfonumber是否返回link詳情是否返回link詳情，包括linkid、車速等信息

0:不返回（默認(rèn)）

1:返回否langnumber語言類型語言類型：

0:中文chn(默認(rèn))

1:英文eng否響應(yīng)參數(shù)字段名稱字段類型字段含義規(guī)則說明statusnumber服務(wù)返回碼0：請求成功；非0：請求失敗，失敗詳細(xì)狀態(tài)碼和信息參見messagemessagestring服務(wù)返回碼對應(yīng)信息參見狀態(tài)碼說明sheetresultarray返回結(jié)果路算結(jié)果返回countnumber返回路線的總數(shù)返回算路路線總數(shù)，取值為：1-3routesarray返回路線詳情信息路線詳情信息avoid_statusnumber規(guī)避狀態(tài)0：成功規(guī)避所有的避讓點和避讓區(qū)域；

1：避讓失?。籹trategynumber算路策略0：默認(rèn)

1：最短距離（只返回1條路線）

2：不走高速

4：高速優(yōu)先

5：少收費

6：躲避擁堵

7:躲避擁堵&高速優(yōu)先

8:躲避擁堵&不走高速

9:躲避擁堵&少收費

10:躲避擁堵&不走高速&少收費distancenumber路線距離單位：米durationnumber路線耗時單位：秒tollsnumber道路收費單位：元toll_distancenumber收費路段距離單位：米traffic_lightsnumber紅綠燈個數(shù)路線經(jīng)過的紅綠燈總數(shù)restrictionnumber限行結(jié)果信息限行狀態(tài)碼：

0:途經(jīng)沒有限行城市，或路線方案未涉及限行區(qū)域

1:途經(jīng)包含有限行的城市

2:[設(shè)置車牌]已避讓限行

3:[設(shè)置車牌]無法避開限行區(qū)域（本方案包含限行路段）steps分段路線列表分段路線詳情waypoints_idxnumber途徑點序號途徑點序號為從0開始的整數(shù)，用于標(biāo)識step所屬的途徑點路段

如：若該step屬于起點至第一個途徑中的路段，則其waypoints_index為0distancenumber路段長度分段路線長度roadnamestring路段道路名分段道路名orientationstring方向進入道路的方向，取值包括：東、南、西、北、東南、西南、東北、西北等instructionstring路線提示描述路線引導(dǎo)提示描述，如：“沿望京街向東南行駛398米左轉(zhuǎn)”actionstring路線主要動作0:無效

1:直行

2:左轉(zhuǎn)

3:右轉(zhuǎn)

4:向左前方行駛

5:向右前方行駛

6:向左后方行駛

7:向右后方行駛

8:保持左側(cè)行駛

9:保持右側(cè)行駛

10:直行走左側(cè)岔道

11:直行走右側(cè)岔道

12:左轉(zhuǎn)走左側(cè)岔道

13:左轉(zhuǎn)走右側(cè)岔道

14:右轉(zhuǎn)走左側(cè)岔道

15:右轉(zhuǎn)走右側(cè)岔道

16:掉頭assistant_actionstring路線輔助動作0:無輔助動作

1:進入主路

2:駛出主路

3:進入輔路

4:進入環(huán)島

5:駛出環(huán)島

6:進入隧道

7:進入匝道

8:進入輪渡

9:到達目的地的

10:進入右轉(zhuǎn)專用道

11:經(jīng)過左轉(zhuǎn)車道

12:穿過公園

13:穿越廣場

14:通過人行道

15:經(jīng)過地下通道

16:過街天橋

17:沿環(huán)島走

18:過橋

19:過馬路，無人行道

20:走階梯

21:進入小環(huán)島

22:離開高速

23:進入高速

24:到達收費站

25:沿輔路行駛

26:沿主路行駛

27:進入內(nèi)部道路

28:在匝道上轉(zhuǎn)彎

29:上高架

30:下高架

31:到達途經(jīng)地citystring途徑城市名稱途徑城市名稱列表，城市之間以英文半角逗號相隔adcodesnumber途徑城市編碼若途經(jīng)多個城市，則adcode以英文半角逗號相隔polylinestring坐標(biāo)點序列格式為坐標(biāo)串，如：116.481247,39.990704;116.481270,39.990726tmc路況詳情列表分段路線詳情statusnumber

擁堵狀態(tài)級別0:無路況

1:暢通

2:緩行

3:擁堵

4:非常擁堵start_idxnumber當(dāng)前狀態(tài)開始坐標(biāo)序號當(dāng)前擁堵狀態(tài)開始的坐標(biāo)序號（按擁堵狀態(tài)進行拼接）end_idxnumber當(dāng)前狀態(tài)結(jié)束的坐標(biāo)序號當(dāng)前擁堵狀態(tài)結(jié)束的坐標(biāo)序號（按擁堵狀態(tài)進行拼接）lengthnumber擁堵狀態(tài)級別對應(yīng)的長度(單位：米)當(dāng)前擁堵狀態(tài)級別對應(yīng)的長度（按擁堵狀態(tài)進行拼接）linkinfolink詳情列表linkidstring分段路線linkid信息根據(jù)入?yún)⒋_定是否返回：

當(dāng)前分段路線對應(yīng)的linkidtraffic_speedsnumber每個link的當(dāng)前路況速度link對應(yīng)的路況速度link_pointsstringlink坐標(biāo)點序列根據(jù)入?yún)⒋_定是否返回：

當(dāng)前分段路線對應(yīng)的link坐標(biāo)點，格式為坐標(biāo)串，如116.481247,39.990704;116.481270,39.990726貨車路徑規(guī)劃接口地址：/service/lbs/route/v1/truck接口描述：針對不同貨車類型和自身信息,輸入起止點坐標(biāo)及途經(jīng)點,避讓區(qū)域等信息,針對不同策略,規(guī)劃出最優(yōu)貨車行駛路線。請求參數(shù)字段名稱字段類型字段含義規(guī)則說明是否必填keystring用戶唯一標(biāo)識及鑒權(quán)id用戶在minedata官網(wǎng)或本地部署門戶申請是originstring起點經(jīng)度在前，緯度在后，經(jīng)度和緯度用","分割，經(jīng)緯度小數(shù)點后不得超過6位。是headingnumber定位方向起點的車頭方向。取值范圍：0-359否destinationstring終點經(jīng)度在前，緯度在后，經(jīng)度和緯度用","分割，經(jīng)緯度小數(shù)點后不得超過6位。是avoidpolygonsstring避讓區(qū)域區(qū)域避讓，支持32個避讓區(qū)域，每個區(qū)域最多可有16個頂點

經(jīng)度和緯度用","分割，經(jīng)度在前，緯度在后，小數(shù)點后不超過6位，坐標(biāo)點之間用";"分隔，區(qū)域之間用"|"分隔。如果是四邊形則有四個坐標(biāo)點，如果是五邊形則有五個坐標(biāo)點；

避讓區(qū)域不能超過81平方公里，否則避讓區(qū)域會失效。否avoidpointsstring避讓點避讓點用lng,lat<中心坐標(biāo)>;radius<半徑/米>表達,多個避讓點之間以英文豎線|分割否waypointsstring途徑點經(jīng)度和緯度用","分割，經(jīng)度在前，緯度在后，小數(shù)點后不超過6位，坐標(biāo)點之間用";"分隔

最大數(shù)目：50個坐標(biāo)點。如果輸入多個途徑點，則按照用戶輸入的順序進行路徑規(guī)劃否strategynumber算路策略0：默認(rèn)

1：最短距離

2：不走高速

3：高速優(yōu)先

4：少收費

5：躲避擁堵

6:躲避擁堵&高速優(yōu)先

7:躲避擁堵&不走高速

8:躲避擁堵&少收費

9:躲避擁堵&不走高速&少收費否ferrynumber是否走輪渡0:使用渡輪(默認(rèn))

1:不使用渡輪否alternativesnumber備選路線是否返回備選路線

可選值：

0:返回1條路線（默認(rèn)）

1:返回1-3條路線否heightnumber車輛高度單位：米，取值[0,25.5]米，默認(rèn)1.6米，會嚴(yán)格按照填寫數(shù)字進行限行規(guī)避，請按照車輛真實信息合理填寫。

否widthnumber車輛寬度單位：米，取值[0,25.5]米，默認(rèn)2.5米，會嚴(yán)格按照填寫數(shù)字進行限行規(guī)避，請按照車輛真實信息合理填寫。

否weightnumber車輛總重單位：噸，取值[0,100]噸，默認(rèn)10噸，會嚴(yán)格按照填寫數(shù)字進行限行規(guī)避，請按照車輛真實信息合理填寫。總重的含義是核定載重加上車輛自重。否lengthnumber車輛長度單位：米，取值[0,20.0]，默認(rèn)4.2，會按照填寫數(shù)字進行限行規(guī)避否axle_weightnumber軸重單位：噸，取值[0,50]，默認(rèn)2，會按照填寫數(shù)字進行限行規(guī)避否axle_countnumber軸數(shù)單位：個，取值[0,255]個，默認(rèn)2個軸，會嚴(yán)格按照填寫數(shù)字進行限行規(guī)避，請按照車輛真實信息合理填寫。否passportnumber是否有通行證是否擁有通行證，缺省為擁有通行證

0：擁有通行證（默認(rèn)）

1：沒有通行證否emission_limitnumber排放標(biāo)準(zhǔn)機動車污染物排放標(biāo)準(zhǔn)取值范圍1-6，對應(yīng)國1-國6標(biāo)準(zhǔn)，

1:國I標(biāo)準(zhǔn);

2:國II標(biāo)準(zhǔn);

3:國III標(biāo)準(zhǔn);

4:國IV標(biāo)準(zhǔn);

5:國V標(biāo)準(zhǔn)

6:國VI標(biāo)準(zhǔn)否loadnumber核定載重單位：噸，取值[0,100）噸，默認(rèn)0.9噸，會嚴(yán)格按照填寫數(shù)字進行限行規(guī)避，請按照車輛真實信息合理填寫。核定載重的含義是可裝載貨物的最大重量。否is_trailernumber貨車類型（是否掛車）0：不是(默認(rèn))

1：是否sizenumber車輛大小貨車負(fù)載類型

1:微型貨車，廠定最大總質(zhì)量<=1.8噸;

2:輕型貨車，1.8噸<廠定最大總質(zhì)量<=6噸;

3:中型貨車，6噸<廠定最大總質(zhì)量<=14噸;

4:重型貨車，廠定最大總質(zhì)量>=14噸否cartypenumber車輛類型車輛類型（影響限行規(guī)則），取值：

0:普通汽車(默認(rèn))

1:新能源

2:插電混動車否plate_numberstring車牌號lng,lat,timestamp;lng,lat,imestamp;lng,lat,timestamp’|‘lng,lat,timestamp;lng,lat,timestamp.....

軌跡點間英文分號分割，分段軌跡間以英文豎線分割，軌跡分段最多3個

如無時間戳可設(shè)置為0，所有軌跡點個數(shù)<2000。坐標(biāo)類型受參數(shù)coord_type約定

如果傳遞此參數(shù)，則必須采用post方式發(fā)送Http請求否linkinfonumber是否返回link詳情是否返回link詳情，包括linkid、車速等信息

0:不返回（默認(rèn)）

1:返回否langnumber語言類型語言類型：

0:中文chn(默認(rèn))

1:英文eng否響應(yīng)參數(shù)字段名稱字段類型字段含義規(guī)則說明statusnumber服務(wù)返回碼0：請求成功；非0：請求失敗，失敗詳細(xì)狀態(tài)碼和信息參見messagemessagestring服務(wù)返回碼對應(yīng)信息參見狀態(tài)碼說明sheetresultarray返回結(jié)果路算結(jié)果返回countnumber返回路線的總數(shù)返回算路路線總數(shù)，取值為：1-3routesarray返回路線詳情信息路線詳情信息strategynumber算路策略0：默認(rèn)

1：最短距離

2：不走高速

4：高速優(yōu)先

5：少收費

6：躲避擁堵

7:躲避擁堵&高速優(yōu)先

8:躲避擁堵&不走高速

9:躲避擁堵&少收費

10:躲避擁堵&不走高速&少收費distance路線距離單位：米durationnumber路線耗時單位：秒traffic_lightsnumber紅綠燈個數(shù)路線經(jīng)過的紅綠燈總數(shù)restrictionnumber限行結(jié)果信息限行狀態(tài)碼：

0:途經(jīng)沒有限行城市，或路線方案未涉及限行區(qū)域

1:途經(jīng)包含有限行的城市

3:[設(shè)置車牌]已避讓限行

4:[設(shè)置車牌]無法避開限行區(qū)域（本方案包含限行路段）steps分段路線列表分段路線詳情waypoints_idxnumber途徑點序號途徑點序號為從0開始的整數(shù)，用于標(biāo)識step所屬的途徑點路段

如：若該step屬于起點至第一個途徑中的路段，則其waypoints_index為0distancenumber路段長度分段路線長度roadnamestring路段道路名分段道路名orientationstring方向進入道路的方向，取值包括：東、南、西、北、東南、西南、東北、西北等instructionstring路線提示描述路線引導(dǎo)提示描述，如：“沿望京街向東南行駛398米左轉(zhuǎn)”actionstring路線主要動作0:無效

1:直行

2:左轉(zhuǎn)

3:右轉(zhuǎn)

4:向左前方行駛

5:向右前方行駛

6:向左后方行駛

7:向右后方行駛

8:保持左側(cè)行駛

9:保持右側(cè)行駛

10:直行走左側(cè)岔道

11:直行走右側(cè)岔道

12:左轉(zhuǎn)走左側(cè)岔道

13:左轉(zhuǎn)走右側(cè)岔道

14:右轉(zhuǎn)走左側(cè)岔道

15:右轉(zhuǎn)走右側(cè)岔道

16:掉頭

17:進入環(huán)島

18:離開環(huán)島

19:減速行駛assistant_actionstring路線輔助動作詳見備注內(nèi)容polylinestring坐標(biāo)點序列格式為坐標(biāo)串，如：116.481247,39.990704;116.481270,39.990726tmc路況詳情列表分段路線詳情statusnumber

擁堵狀態(tài)級別0:無路況

1:暢通

2:緩行

3:擁堵

4:非常擁堵start_idxnumber當(dāng)前狀態(tài)開始坐標(biāo)序號當(dāng)前擁堵狀態(tài)開始的坐標(biāo)序號（按擁堵狀態(tài)進行拼接）end_idxnumber當(dāng)前狀態(tài)結(jié)束的坐標(biāo)序號當(dāng)前擁堵狀態(tài)結(jié)束的坐標(biāo)序號（按擁堵狀態(tài)進行拼接）lengthnumber擁堵狀態(tài)級別對應(yīng)的長度當(dāng)前擁堵狀態(tài)級別對應(yīng)的長度（按擁堵狀態(tài)進行拼接）linkinfolink詳情列表linkidstring分段路線linkid信息根據(jù)入?yún)⒋_定是否返回：

當(dāng)前分段路線對應(yīng)的linkidtraffic_speedsstring每個link的當(dāng)前路況速度根據(jù)入?yún)⒋_定是否返回：

當(dāng)前分段路線對應(yīng)的路況速度,對應(yīng)link中每個路段,返回值示例:"30,60x8,30,80,?x3",x8表示連續(xù)8個60,?表示速度未知link_pointsstringlink坐標(biāo)點序列根據(jù)入?yún)⒋_定是否返回：

當(dāng)前分段路線對應(yīng)的link坐標(biāo)點，格式為坐標(biāo)串，如116.481247,39.990704;116.481270,39.990726height_limitstring道路、路口、橋梁限高單位為米width_limitstring道路、路口、橋梁限寬單位為米weight_limitstring道路、路口、橋梁限重單位為噸slopestring道路坡度單位為度，水平為零度，下坡為負(fù)度數(shù)，上坡為正度數(shù)curvaturestring道路曲率單位為度，逆時針為負(fù)度數(shù)，順時針為正度數(shù)步行路徑規(guī)劃接口地址：/service/lbs/route/v