控制台
开发 地图小程序OPENAPI 开发指南 地图内容 地图路线

地图路线 最后更新时间: 2024年08月30日

1、路线创建

请求地址：

URL

https://restwia.amap.com/api/v1/wia/map/line/create?parameters

请求方式

POST

ContenType

application/json

url 请求参数

参数名

参数类型

含义

规则

示例值

是否必填

key

String

高德Key

用户在高德地图官网申请Web服务API类型Key

必填

bizToken

String

工作地图身份token

用户申请的工作地图身份token，一个企业一个token

必填

openId

String

当前操作人

高德用户的开放id

必填

sig

String

数字签名

请参考数字签名获取和使用方法

选填

bizSign

String

业务签名

签名参数openId，bizToken（参考签名规则）

必填

body请求参数

参数名

参数类型

含义

规则

示例值

是否必填

workMapId

String

工作地图id

P3AOnftSzq7bdMTxw057Sg

必填

title

String

路线标题

测试路线

必填

pointInfoList

Array

途径点集合

详见附件

pointInfoList详细参数说明

[{"alias":"点1","pointInfo":{"name":"马家楼桥","address":"丰台区","lon":116.34544283151628,"lat":39.83106224363813}},{"alias":"点2","pointInfo":{"address":"丰台区","name":"公益西桥","lon":116.36949285864833,"lat":39.831144634224266}}]

必填

planRoute

Boolean

路线规划

true

必填

createUserId

String

创建人openId

非必填

navigationType

Number

导航方式

DRIVE(1, "驾车"), 

RIDE(2, "骑行"), 

WALK(3,"步行"), 

MOTO(4,"摩托"),

TRUCK(5,"货车")

1

非必填

iconColorValue

String

颜色

颜色值十六进制，点之间用用逗号隔开，默认值蓝色：#7E97FF,#4265FF

BLUE_1(1, "#7E97FF,#4265FF","蓝1"), 

BLUE_2(2, "#7AB1F5,#307EDF","蓝2"), 

BLUE_3(3, "#4CC7FF,#39A1F8","蓝3"), 

CYCAN(4, "#12E3AA,#18AD78","青"), 

YELLOW(5, "#FFBF00,#FD9A00","黄"), 

ORANGE(6, "#FF983F,#F96328","橙"), 

RED_1(7, "#EA7864,#D76049","红1"), 

RED_2(8, "#FF6968,#F74746","红2");

非必填

iconColorId

String

自定义颜色id

使用自定义颜色必须同时携带iconColorId和iconColorValue

非必填

workItemEntityList

Array

任务指派信息集合

[{"assignedUserId":"被指派人openId"}]

非必填

categoryId

String

分组id

非必填

sceneType

Number

场景类型

0:默认场景

1:常用地图内置资源场景

非必填

principalIdListJsonString

String

负责人openId

多个负责人之间用逗号隔开

"openId1,openId2"

非必填

dimensionId

String

地图功能id(资源来源区分)

非必填

customFieldValueInfoList

Array

自定义字段集合

[{"itemId":"123","itemType":1,"valueList":[{"value":"123","id":"123","remarkValue":"123123131"},{"value":"123","id":"123","remarkValue":"123123131"}]}]

非必填

示例代码（以java为例）

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String requestUrl = "https://restwia.amap.com/api/v1/wia/map/line/create";

      
        //url param
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key", "在高德开放平台申请的key");
        param1.put("openId", "当前操作用户的openId");
        param1.put("bizToken", "在高德开放平台申请的bizToken");
        param1.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"openId","bizToken"}));

        //body
        HashMap<String, Object> param2 = Maps.newHashMap();
        param2.put("workMapId","工作地图id");
        param2.put("title","测试路线");
        ArrayList<Map<String,Object>> pointInfoList = Lists.newArrayList();
        HashMap<String, Object> point01 = Maps.newHashMap();
        point01.put("alias","资源点1");
        HashMap<String, Object> pointInfo01 = Maps.newHashMap();
        pointInfo01.put("name","马家楼桥");
        pointInfo01.put("address","丰台区");
        pointInfo01.put("lon","116.34544283151628");
        pointInfo01.put("lat","39.83106224363813");
        point01.put("pointInfo",pointInfo01);
        pointInfoList.add(point01);
        HashMap<String, Object> point02 = Maps.newHashMap();
        point02.put("alias","资源点2");
        HashMap<String, Object> pointInfo02 = Maps.newHashMap();
        pointInfo02.put("name","大红门桥");
        pointInfo02.put("address","丰台区");
        pointInfo02.put("lon","116.40109866857532");
        pointInfo02.put("lat","39.832299121918304");
        point02.put("pointInfo",pointInfo02);
        pointInfoList.add(point02);
        param2.put("pointInfoList",pointInfoList);
        param2.put("planRoute",true);
        param2.put("navigationType",1);
        // param2.put("iconColorValue","#FF6968,#F74746");
        param2.put("sceneType",0);
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,param1);
        String s = MyHttpUtils.postApplicationJson(requestUrl, JSONObject.toJSONString(param2));
        System.out.println("s = " + s);
}

入参实例

{
    "workMapId": "B70bByvTOEPY0effRRsMuA",
    "title": "路线规划-阳阳",
    "pointInfoList": [
        {
            "alias":"浏阳市淳口镇长丰商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村楼古集镇",
                "lon": "113.5042160000613",
                "name": "浏阳市淳口镇长丰商店",
                "lat": "28.357623000019746"
            }
        },
        {
            "alias":"浏阳市淳口镇蕾蕾商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村金盆组318号",
                "lon": "113.50536575002431",
                "name": "浏阳市淳口镇蕾蕾商店",
                "lat": "28.359188500029557"
            }
        },
        {
            "alias":"浏阳市淳口镇胖哥商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村新园组40号",
                "lon": "113.50136333336512",
                "name": "浏阳市淳口镇胖哥商店",
                "lat": "28.365254333357832"
            }
        },
        {
            "alias":"浏阳市淳口镇熊家商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村代新组30号",
                "lon": "113.50141000004889",
                "name": "浏阳市淳口镇熊家商店",
                "lat": "28.365203666694605"
            }
        },
        {
            "alias":"浏阳市淳口镇鸭头村友友商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村杉山组",
                "lon": "113.50135933335014",
                "name": "浏阳市淳口镇鸭头村友友商店",
                "lat": "28.365211333350036"
            }
        },
        {
            "alias":"浏阳市淳口镇利民商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村培上组53号",
                "lon": "113.48869166665028",
                "name": "浏阳市淳口镇利民商店",
                "lat": "28.364809333344816"
            }
        },
        {
            "alias":"浏阳市淳口镇真好商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村楼古集镇",
                "lon": "113.48183933333078",
                "name": "浏阳市淳口镇真好商店",
                "lat": "28.36485133333542"
            }
        },
        {
            "alias":"浏阳市淳口镇周周商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村永清组",
                "lon": "113.48877699999574",
                "name": "浏阳市淳口镇周周商店",
                "lat": "28.36485533334698"
            }
        },
        {
            "alias":"浏阳市淳口镇大路商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村肖家组",
                "lon": "113.49237774999565",
                "name": "浏阳市淳口镇大路商店",
                "lat": "28.365811500008274"
            }
        },
        {
             "alias":"罗刚—湖南省浏阳市",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村省埠片",
                "lon": "113.49576524999868",
                "name": "罗刚—湖南省浏阳市",
                "lat": "28.364602000000392"
            }
        },
        {
            "alias":"浏阳市淳口镇长兴商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村培元片",
                "lon": "113.49378333337403",
                "name": "浏阳市淳口镇长兴商店",
                "lat": "28.371749666690363"
            }
        },
        {
            "alias":"浏阳市淳口镇卫秀商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村",
                "lon": "113.49371700000268",
                "name": "浏阳市淳口镇卫秀商店",
                "lat": "28.371795666667484"
            }
        },
        {
            "alias":"浏阳市淳口镇清支商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市淳口镇鸭头村向荣组",
                "lon": "113.49317933337858",
                "name": "浏阳市淳口镇清支商店",
                "lat": "28.372481000009657"
            }
        },
        {
            "alias":"浏阳市龙伏镇卫记商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市龙伏镇坪上村",
                "lon": "113.49319000000023",
                "name": "浏阳市龙伏镇卫记商店",
                "lat": "28.372436000000235"
            }
        },
        {
            "alias":"浏阳市龙伏镇晟旺商店",
            "pointInfo": {
                "address": "湖南省长沙市浏阳市龙伏镇焦桥村江边组",
                "lon": "113.4914703333364",
                "name": "浏阳市龙伏镇晟旺商店",
                "lat": "28.384381000003916"
            }
        }
    ],
    "planRoute": true,
    "navigationType": 1,
    "iconColorValue": "#7E97FF,#4265FF"
}

返回参数

响应结果的格式为 JSON 形式，以下是参数说明

参数名

含义

参数类型

规则说明

data

返回结果数据

Object

workMapId

工作地图id

String

resourceId

路线id

String

code

返回结果状态值

Number

message

返回状态说明

String

成功时返回Successful，否则返回错误原因

result

结果

Boolean

true或false

version

版本信息

String

timestamp

时间戳

Number

requestId

请求id

String

返回示例

{
    "data": {
        "workMapId": "P3AOnftSzq7bdMTxw057Sg",
        "resourceId": "2003003712473160"
    },
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1702451349548,
    "requestId": "1eb5d13017024513445691002d1aec"
}

2、路线修改

请求地址：

URL

https://restwia.amap.com/api/v1/wia/map/line/update?parameters

请求方式

POST

ContenType

application/json

url 请求参数

参数名

参数类型

含义

规则

示例值

是否必填

key

String

高德Key

用户在高德地图官网申请Web服务API类型Key

必填

bizToken

String

工作地图身份token

用户申请的工作地图身份token，一个企业一个token

必填

openId

String

当前操作人

高德用户的开放id

必填

sig

String

数字签名

请参考数字签名获取和使用方法

选填

bizSign

String

业务签名

签名参数openId，bizToken（参考签名规则）

必填

示例代码（以java为例）

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String requestUrl = "https://restwia.amap.com/api/v1/wia/map/line/update";
        //url param
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key", "在高德开放平台申请的key");
        param1.put("openId", "当前操作用户的openId");
        param1.put("bizToken", "在高德开放平台申请的bizToken");
        param1.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"openId","bizToken"}));

        //body
        HashMap<String, Object> param2 = Maps.newHashMap();
        param2.put("workMapId","工作地图id");
        param2.put("resourceId","任务id");
        param2.put("title","测试路线");
        ArrayList<Map<String,Object>> pointInfoList = Lists.newArrayList();
        HashMap<String, Object> point01 = Maps.newHashMap();
        point01.put("alias","资源点1");
        HashMap<String, Object> pointInfo01 = Maps.newHashMap();
        pointInfo01.put("name","马家楼桥");
        pointInfo01.put("address","丰台区");
        pointInfo01.put("lon","116.34544283151628");
        pointInfo01.put("lat","39.83106224363813");
        point01.put("pointInfo",pointInfo01);
        pointInfoList.add(point01);
        HashMap<String, Object> point02 = Maps.newHashMap();
        point02.put("alias","资源点2");
        HashMap<String, Object> pointInfo02 = Maps.newHashMap();
        pointInfo02.put("name","大红门桥");
        pointInfo02.put("address","丰台区");
        pointInfo02.put("lon","116.40109866857532");
        pointInfo02.put("lat","39.832299121918304");
        point02.put("pointInfo",pointInfo02);
        pointInfoList.add(point02);
        param2.put("pointInfoList",pointInfoList);
        param2.put("planRoute",true);
        param2.put("navigationType",1);
        // param2.put("iconColorValue","#FF6968,#F74746");
        param2.put("sceneType",0);
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,param1);
        String s = MyHttpUtils.postApplicationJson(requestUrl, JSONObject.toJSONString(param2));
        System.out.println("s = " + s);
}

body请求参数

参数名

参数类型

含义

规则

示例值

是否必填

resourceId

String

路线资源Id

必填

workMapId

String

工作地图id

P3AOnftSzq7bdMTxw057Sg

必填

title

String

路线标题

测试路线

必填

pointInfoList

Array

途径点集合

详见附件

pointInfoList详细参数说明

[{"alias":"点1","pointInfo":{"name":"马家楼桥","address":"丰台区","lon":116.34544283151628,"lat":39.83106224363813}},{"alias":"点2","pointInfo":{"address":"丰台区","name":"公益西桥","lon":116.36949285864833,"lat":39.831144634224266}}]

必填

planRoute

Boolean

路线规划

true

必填

createUserId

String

创建人openId

非必填

navigationType

Number

导航方式

DRIVE(1, "驾车"), 

RIDE(2, "骑行"), 

WALK(3,"步行"), 

MOTO(4,"摩托"),

TRUCK(5,"货车")

1

非必填

iconColorValue

String

颜色

颜色值十六进制，点之间用用逗号隔开，默认值蓝色

BLUE_1(1, "#7E97FF,#4265FF","蓝1"), 

BLUE_2(2, "#7AB1F5,#307EDF","蓝2"), 

BLUE_3(3, "#4CC7FF,#39A1F8","蓝3"), 

CYCAN(4, "#12E3AA,#18AD78","青"), 

YELLOW(5, "#FFBF00,#FD9A00","黄"), 

ORANGE(6, "#FF983F,#F96328","橙"), 

RED_1(7, "#EA7864,#D76049","红1"), 

RED_2(8, "#FF6968,#F74746","红2");

非必填

iconColorId

String

自定义颜色id

使用自定义颜色必须同时携带iconColorId和iconColorValue

非必填

workItemEntityList

Array

任务指派信息集合

[{"assignedUserId":"被指派人openId"},

"workTaskId":"任务id"]

非必填

categoryId

String

分组id

非必填

sceneType

Number

场景类型

0:默认场景

1:常用地图内置资源场景

非必填

principalIdListJsonString

String

负责人openId

多个负责人之间用逗号隔开

"openId1,openId2"

非必填

dimensionId

String

地图功能id(资源来源区分)

非必填

customFieldValueInfoList

Array

自定义字段集合

[{"itemId":"123","itemType":1,"valueList":[{"value":"123","id":"123","remarkValue":"123123131"},{"value":"123","id":"123","remarkValue":"123123131"}]}]

非必填

返回参数

响应结果的格式为 JSON 形式，以下是参数说明

参数名

含义

参数类型

规则说明

data

返回结果数据

Object

code

返回结果状态值

Number

message

返回状态说明

String

成功时返回Successful，否则返回错误原因

result

结果

Boolean

true或false

version

版本信息

String

timestamp

时间戳

Number

requestId

请求id

String

返回示例

{
    "data": tue,
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1701142286019,
    "requestId": "1eb5d12017011422856761177d14ca"
}

3、路线删除

请求地址：

URL

https://restwia.amap.com/api/v1/wia/map/line/delete?parameters

请求方式

POST

ContenType

application/json

url 请求参数

参数名

参数类型

含义

规则

示例值

是否必填

key

String

高德Key

用户在高德地图官网申请Web服务API类型Key

必填

bizToken

String

工作地图身份token

用户申请的工作地图身份token，一个企业一个token

必填

openId

String

当前操作人

高德用户的开放id

必填

sig

String

数字签名

请参考数字签名获取和使用方法

选填

bizSign

String

业务签名

签名参数openId，bizToken（参考签名规则）

必填

示例代码（以java为例）

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
        String requestUrl = "https://restwia.amap.com/api/v1/wia/map/line/delete";
        //url param
        HashMap<String, Object> param1 = Maps.newHashMap();
        param1.put("key", "在高德开放平台申请的key");
        param1.put("openId", "当前操作用户的openId");
        param1.put("bizToken", "在高德开放平台申请的bizToken");
        param1.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"openId","bizToken"}));

        //body
        HashMap<String, Object> param2 = Maps.newHashMap();
        param2.put("workMapId","工作地图id");
        param2.put("resourceId","任务id");
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,param1);
        String s = MyHttpUtils.postApplicationJson(requestUrl, JSONObject.toJSONString(param2));
        System.out.println("s = " + s);
}

body请求参数

参数名

参数类型

含义

规则

示例值

是否必填

workMapId

String

工作地图id

P3AOnftSzq7bdMTxw057Sg

必填

resourceId

String

路线id

返回参数

响应结果的格式为 JSON 形式，以下是参数说明

参数名

含义

参数类型

规则说明

data

返回结果数据

Boolean

成功返回true

code

返回结果状态值

Number

message

返回状态说明

String

成功时返回Successful，否则返回错误原因

result

结果

Boolean

version

版本信息

String

timestamp

时间戳

Number

requestId

请求id

String

返回示例

{
    "data": true,
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1708511483526,
    "requestId": "1eb5d11517085114640361002d38a4"
}

附件 

pointInfoList详细参数说明

参数名

参数类型

含义

规则

是否必填

alias

String

点的别名

必填

desc

String

描述

非必填

sortOrder

number

排序

非必填

iconColorValue

String

颜色

非必填

pointInfo

object

必填

address

string

地址

name

string

名称

lon

string

经度

lat

string

纬度

imageList

array

非必填

originalUrl

string

图片url

sortOrder

number

图片顺序

本页目录
返回顶部 示例中心 常见问题 智能客服 公众号
二维码