围栏管理类接口从功能上区分为两类接口:
1、管理围栏属性接口:管理围栏自身属性的变化,包括创建围栏、更新围栏形状、删除围栏、查询围栏自身属性信息。支持设置监控一个service下的所有围栏。支持以下类型的围栏
1)圆形
2)多边形
3)路线
4)行政区
2、管理围栏监控对象接口:管理围栏的监控对象,包括:
1)添加监控对象
2)删除监控对象
3)查询监控对象
地理围栏的使用方法详见:开发指南--地理围栏
模块 | 接口名称 | 接口名称 | 功能说明 |
---|---|---|---|
fence | 管理围栏属性 | createcirclefence | 创建圆形围栏 |
createpolygonfence | 创建多边形围栏 | ||
createpolylinefence | 创建线型围栏 | ||
createdistrictfence | 创建行政区划围栏 | ||
updatecirclefence | 更新圆形围栏 | ||
updatepolygonfence | 更新多边形围栏 | ||
updatepolylinefence | 更新线型围栏 | ||
updatedistrictfence | 更新行政区划围栏 | ||
delete | 删除围栏 | ||
list | 查询围栏信息 | ||
管理围栏监控对象 | addmonitoredperson | 增加围栏需监控的entity | |
deletemonitoredperson | 删除围栏可监控的entity | ||
listmonitoredperson | 查询围栏监控的所有entity |
目前中国主要有以下三种坐标系:
wgs84:为一种大地坐标系,也是目前广泛使用的gps全球卫星定位系统使用的坐标系
gcj02:是由中国国家测绘局制订的地理信息系统的坐标系统。由wgs84坐标系经加密后的坐标系
bd09:为百度坐标系,在gcj02坐标系基础上再次加密。其中bd09ll表示百度经纬度坐标,bd09mc表示百度墨卡托米制坐标
非中国地区地图,统一使用wgs84坐标
鹰眼 web服务api v3.0的默认输入输出参数为百度坐标(bd09),同时可通过"coord_type","coord_type_input","coord_type_output"(以各服务参数介绍为准)控制输入输出的坐标类型,鹰眼将自动完成转换。
1、使用鹰眼地理围栏管理接口创建或修改围栏时,请注意正确填写参数中的经度和纬度,如圆形围栏创建的参数longitude、latitude;多边形围栏创建的参数vertexes等(以各服务参数介绍为准)。
2、如创建时坐标中经度和纬度的顺序不正确,则不能成功创建和修改围栏。
以中心点和半径创建一个圆形围栏。
支持三种监控模式:
1、监控一个entity的围栏
2、监控多个entity的围栏
3、监控service下的所有entity围栏
https://yingyan.baidu.com/api/v3/fence/createcirclefence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak | string | 是 | |
service_id | service的id,service 的唯一标识 | int | 是 | service 的唯一标识。在轨迹管理台创建鹰眼服务时,系统返回的 service_id |
fence_name | 围栏名称 | string(128) | 否 | |
monitored_person | 监控对象 | string | 否 | 监控对象的entity_name,使用说明: |
longitude | 围栏圆心经度 | double | 是 | |
latitude | 围栏圆心纬度 | double | 是 | |
radius | 围栏半径 | double | 是 | 单位:米,取值范围(0,5000] |
coord_type | 坐标类型 | string | 是 | 坐标类型定义如下: |
denoise | 围栏去噪参数 | int | 否 | 单位:米。每个轨迹点都有一个定位误差半径radius,这个值越大,代表定位越不准确,可能是噪点。围栏计算时,如果噪点也参与计算,会造成误报的情况。设置denoise可控制,当轨迹点的定位误差半径大于设置值时,就会把该轨迹点当做噪点,不参与围栏计算。denoise默认值为0,不去噪。 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
fence_id | 围栏的唯一标识 | int | fence_id由系统自动生成,按正整数递增 |
{"status":0,"message":"成功","fence_id":1}
以多边形形状点创建多边形围栏。
支持三种监控模式:
1、监控一个entity的围栏
2、监控多个entity的围栏
3、监控service下的所有entity围栏
https://yingyan.baidu.com/api/v3/fence/createpolygonfence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
fence_name | 围栏名称 | string(128) | 否 | |
monitored_person | 监控对象 | string | 否 | 监控对象的entity_name,使用说明: |
vertexes | 多边形围栏形状点 | “double,double; double,double; ...;double,double” | 是 | 经纬度顺序为:纬度,经度; |
coord_type | 坐标类型 | string | 是 | 坐标类型定义如下: |
denoise | 围栏去噪参数 | int | 否 | 单位:米。每个轨迹点都有一个定位误差半径radius,这个值越大,代表定位越不准确,可能是噪点。围栏计算时,如果噪点也参与计算,会造成误报的情况。设置denoise可控制,当轨迹点的定位误差半径大于设置值时,就会把该轨迹点当做噪点,不参与围栏计算。denoise默认值为0,不去噪。 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
fence_id | 围栏的唯一标识 | int | fence_id由系统自动生成,按正整数递增 |
{"status":0,"message":"成功","fence_id":2}
以路线形状点创建线型围栏。
支持三种监控模式:
1、监控一个entity的围栏
2、监控多个entity的围栏
3、监控service下的所有entity围栏
https://yingyan.baidu.com/api/v3/fence/createpolylinefence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
fence_name | 围栏名称 | string(128) | 否 | |
monitored_person | 监控对象 | string | 否 | 监控对象的entity_name,使用说明: |
vertexes | 线型围栏坐标点 | “double,double; double,double; ...;double,double” | 是 | 经纬度顺序为:纬度,经度; |
offset | 偏离距离 | int | 是 | 偏移距离(若偏离折线距离超过该距离即报警),单位:米,取值范围(0,200] 示例:100 |
coord_type | 坐标类型 | string | 是 | 坐标类型定义如下: |
denoise | 围栏去噪参数 | int | 否 | 单位:米。每个轨迹点都有一个定位误差半径radius,这个值越大,代表定位越不准确,可能是噪点。围栏计算时,如果噪点也参与计算,会造成误报的情况。设置denoise可控制,当轨迹点的定位误差半径大于设置值时,就会把该轨迹点当做噪点,不参与围栏计算。denoise默认值为0,不去噪。 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
fence_id | 围栏的唯一标识 | int | fence_id由系统自动生成,按正整数递增 |
{"status":0,"message":"成功","fence_id":3}
以行政区划关键字创建围栏。
1. 若关键字匹配至唯一的行政区划,则将创建该围栏
2. 若关键字匹配至多个行政区划,则围栏创建失败,将返回匹配的行政区划名称列表
支持三种监控模式:
1、监控一个entity的围栏
2、监控多个entity的围栏
3、监控service下的所有entity围栏
https://yingyan.baidu.com/api/v3/fence/createdistrictfence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
fence_name | 围栏名称 | string(128) | 否 | |
monitored_person | 监控对象 | string | 否 | 监控对象的entity_name,使用说明: |
keyword | 行政区划关键字 | string | 是 | 支持中国国家、省、市、区/县、乡镇名称。请尽量输入完整的行政区层级和名称,保证名称的唯一性。若输入的行政区名称匹配多个行政区,围栏将创建失败。 示例: 中国 北京市 湖南省长沙市 湖南省长沙市雨花区 |
denoise | 围栏去噪参数 | int | 否 | 单位:米。每个轨迹点都有一个定位误差半径radius,这个值越大,代表定位越不准确,可能是噪点。围栏计算时,如果噪点也参与计算,会造成误报的情况。设置denoise可控制,当轨迹点的定位误差半径大于设置值时,就会把该轨迹点当做噪点,不参与围栏计算。denoise默认值为0,不去噪。 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
fence_id | 围栏的唯一标识 | int | status=0,围栏创建成功时返回 |
district | 结构化的行政区划描述 | string | status=0,围栏创建成功时返回该字段 |
district_list | 关键字匹配的行政区划列表 | array | tatus=5108,围栏创建失败,关键字匹配至多个行政区时,返回该字段 |
若行政区关键字匹配到唯一的行政区,返回结果示例如下:
{"status":0,"message":"成功","fence_id":1,"district":"北京市海淀区"}
若行政区关键字匹配到多个的行政区,返回结果示例如下:
{"status":5108,"message":"围栏创建失败,该关键字匹配了多个行政区,请输入明确的行政区关键字","district_list":["北京市朝阳区","辽宁省朝阳市"]
更新圆形围栏
https://yingyan.baidu.com/api/v3/fence/updatecirclefence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
fence_id | 围栏的唯一标识 | int | 是 | 用于指定所更新的围栏 |
fence_name | 围栏名称 | string(128) | 否 | 用于描述围栏 |
monitored_person | 监控对象 | string | 否 | 被监控者的entity_name |
longitude | 围栏圆心经度 | double | 否 | |
latitude | 围栏圆心纬度 | double | 否 | |
radius | 围栏半径 | double | 否 | 单位:米,取值范围(0,5000] |
coord_type | 坐标类型 | string | 若更新圆心坐标则必填 | 坐标类型定义如下: |
denoise | 围栏去噪参数 | int | 否 | 单位:米。每个轨迹点都有一个定位误差半径radius,这个值越大,代表定位越不准确,可能是噪点。围栏计算时,如果噪点也参与计算,会造成误报的情况。设置denoise可控制,当轨迹点的定位误差半径大于设置值时,就会把该轨迹点当做噪点,不参与围栏计算。denoise默认值为0,不去噪。 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
{"status":0,"message":"成功",}
更新多边形围栏
https://yingyan.baidu.com/api/v3/fence/updatepolygonfence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
fence_id | 围栏的唯一标识 | int | 是 | 用于指定所更新的围栏 |
fence_name | 围栏名称 | string(128) | 否 | |
monitored_person | 监控对象 | string | 否 | 被监控者的entity_name |
vertexes | 多边形围栏形状点 | “double,double; double,double; ...;double,double” | 是 | 顶点为多边形顺时针或逆时针顺序,顶点个数在3-100个之间 |
coord_type | 坐标类型 | string | 若更新多边形顶点则必填 | 坐标类型定义如下: |
denoise | 围栏去噪参数 | int | 否 | 单位:米。每个轨迹点都有一个定位误差半径radius,这个值越大,代表定位越不准确,可能是噪点。围栏计算时,如果噪点也参与计算,会造成误报的情况。设置denoise可控制,当轨迹点的定位误差半径大于设置值时,就会把该轨迹点当做噪点,不参与围栏计算。denoise默认值为0,不去噪。 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
{"status":0,"message":"成功",}
更新多边形围栏
https://yingyan.baidu.com/api/v3/fence/updatepolylinefence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
fence_id | 围栏的唯一标识 | int | 是 | 用于指定所更新的围栏 |
fence_name | 围栏名称 | string(128) | 否 | |
monitored_person | 监控对象 | string | 否 | 被监控者的entity_name |
vertexes | 线型围栏坐标点 | “double,double; double,double; ...;double,double” | 否 | 1. 普通地理围栏:坐标点个数在2-100个之间,路线长度小于500公里。若传入坐标点个数大于100,则鹰眼将自动对坐标进行适当抽稀,若抽稀后点数仍大于100,则创建围栏将会失败,请开发者自行降低原始坐标点个数。 |
offset | 偏离距离 | int | 否 | 偏移距离(若偏离折线距离超过该距离即报警),单位:米 |
coord_type | 坐标类型 | string | 若更新线型围栏坐标点,则必填 | 坐标类型定义如下: |
denoise | 围栏去噪参数 | int | 否 | 单位:米。每个轨迹点都有一个定位误差半径radius,这个值越大,代表定位越不准确,可能是噪点。围栏计算时,如果噪点也参与计算,会造成误报的情况。设置denoise可控制,当轨迹点的定位误差半径大于设置值时,就会把该轨迹点当做噪点,不参与围栏计算。denoise默认值为0,不去噪。 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
{"status":0,"message":"成功",}
更新行政区划围栏
https://yingyan.baidu.com/api/v3/fence/updatedistrictfence
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 |
---|---|---|---|
ak | 用户的ak,授权使用 | string | 必选 |
service_id | service 的唯一标识 | int | 必选 |
fence_id | 围栏的唯一标识 | int | 必选 |
fence_name | 围栏名称 | string(128) | 可选 ,最长128个字节 |
monitored_person | 监控对象 | string | 可选,轨迹服务中的entity_name |
keyword | 行政区划关键字 | string | 可选 |
denoise | 围栏去噪参数 | int | 可选 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
district | 结构化的行政区划描述 | string | status=0,围栏更新成功时返回该字段 |
district_list | 关键字匹配的行政区划列表 | array | status=5108:围栏更新失败,关键字匹配至多个行政区时,返回该字段 |
{"status":0,"message":"成功","district":"北京市海淀区"}
删除围栏
https://yingyan.baidu.com/api/v3/fence/delete
//post请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
monitored_person | 监控对象 | string | 二个字段至少填写一个 | 1、仅填写monitored_person字段:根据监控对象删除围栏,仅适用于删除“指定entity创建的围栏”,并删除该entity上的所有围栏(兼容旧版本)。 |
fence_ids | 围栏id列表 | “int,int…” | ||
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
fence_ids | 围栏id列表 | array | 返回删除成功的围栏 id 列表 |
{"status":0,"message":"成功","fence_ids":[11,12,13,15]}
查询围栏
https://yingyan.baidu.com/api/v3/fence/list
//get请求
参数名称 | 字段含义 | 数据类型 | 是否必填 | 备注 |
---|---|---|---|---|
ak | 用户的ak,授权使用 | string | 是 | |
service_id | service 的唯一标识 | int | 是 | |
monitored_person | 监控对象 | string | 二个字段至少填写一个 | 1、仅填写monitored_person字段:根据监控对象查询围栏,支持3种查询方式:1)输入某个entity_name查询该监控对象上的所有围栏;2)输入#allentity,查询监控全部entity的公共围栏;3)输入#partofentity,查询监控部分entity的公共围栏。 |
fence_ids | 围栏id列表 | “int,int…” | ||
coord_type_output | 输出坐标类型 | string | 否 | 默认为 bd09ll。 |
page_index | 分页索引 | int(1到2^21-1) | 否 | 默认值:1 |
page_size | 每页返回数据量 | int(1-5000) | 否 | 默认值:1000 |
sn | 用户的权限签名,若用户所用ak的校验方式为sn校验时该参数必须。sn计算方法 | string | 否 |
参数名 | 字段含义 | 类型 | 备注 | ||
---|---|---|---|---|---|
status | 状态码 | ||||
message | 响应信息 | string | 对status的中文描述 | ||
total | 总的查询结果数量 | int | |||
size | 本页返回的结果数量 | int | |||
fences | 围栏列表 | array | |||
fence_id | 围栏唯一标识 | int | |||
fence_name | 围栏名称 | string | |||
monitored_person | 围栏的监控对象 | string | 1. 该围栏仅监控一个entity时,返回entity_name 2. 该围栏监控service下的所有entity时,返回#allentity 3. 该围栏监控service下的部分entity时,返回#partofentity | ||
shape | 围栏的形状 | string | 围栏的四种形状: circle:圆形 polygon:多边形 polyline:线型 district:行政区划 | ||
longitude | 经度 | double | shape=circle时返回 | ||
latitude | 纬度 | double | shape=circle时返回 | ||
radius | 半径 | double | shape=circle时返回,单位米 | ||
vertexes | 多边形和线型围栏的顶点列表 | array | shape=polygon或shape=polyline时返回 | ||
offset | 偏移距离 | double | 仅在shape=polyline时返回偏移距离(若偏离折线距离超过该距离即报警),单位:米 如:200 | ||
coord_type | 返回的坐标类型 | string | 仅在国外区域返回该字段, wgs84:gps经纬度 gcj02:国测局经纬度 bd09ll:百度经纬度 | ||
denoise | 围栏去噪参数 | int | 单位:米 | ||
district | 行政区划描述 | string | shape=district时返回 | ||
create_time | 围栏创建时间 | string | 格式化时间。 示例: 2015-08-19 10:23:20 | ||
modify_time | 围栏修改时间 | string | 格式化时间。 示例: 2015-08-19 10:23:20 |
{"status":0,"message":"成功","size":2,"fences":[{"fence_id":2,"fence_name":"站点1","monitored_person":"小明","shape":"circle","longitude":116.236253,"latitude":39.746539,"radius":500,"denoise":100,"create_time":"2017-03-15 15:56:24","modify_time":"2017-03-15 15:56:24"},{"fence_id":52,"fence_name":"站点2","monitored_person": “小明”,"shape":"polyline","vertexes":"40.020664,116.351592;40.02083,116.358779;40.018178,116.35885;40.01757,116.350586","denoise":100,"create_time":"2017-03-15 15:59:09","modify_time":"2017-03-15 15:59:09"}]}
针对某一个地理围栏增加entity
https://yingyan.baidu.com/api/v3/fence/addmonitoredperson
//post请求
参数名称 | 字段含义 | 数据类型 | 备注 |
---|---|---|---|
ak | 用户的ak,授权使用 | string | 必选 |
service_id | 该围栏实体所属的轨迹服务id | int | 必选 |
fence_id | 围栏的唯一标识 | int | 必选 |
monitored_person | 监控对象 | string | 必选,轨迹服务中的entity_name。 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
删除某一个围栏下的一些entity
https://yingyan.baidu.com/api/v3/fence/deletemonitoredperson
//post请求
参数名称 | 字段含义 | 数据类型 | 备注 |
---|---|---|---|
ak | 用户的ak,授权使用 | string | 必选 |
service_id | 该围栏实体所属的轨迹服务id | int | 必选 |
fence_id | 围栏的唯一标识 | int | 必选 |
monitored_person | 监控对象 | string | 必选,迹服务中的entity_name。 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
查询某service下的某一个围栏下的所有entity,方便开发者管理查询entity
https://yingyan.baidu.com/api/v3/fence/listmonitoredperson
//get请求
参数名称 | 字段含义 | 数据类型 | 备注 |
---|---|---|---|
ak | 用户的ak,授权使用 | string | 必选 |
service_id | 该围栏实体所属的轨迹服务id | int | 必选 |
fence_id | 围栏的唯一标识 | int | 必选 |
page_index | 分页索引 | int | 可选,默认值为1。page_index与page_size一起计算从第几条结果返回,代表返回第几页。 |
page_size | 分页大小 | int | 可选,默认值为100。page_size与page_index一起计算从第几条结果返回,代表返回结果中每页有几条记录。 |
参数名 | 字段含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | 返回状态,0为成功 |
message | 响应信息 | string | 对status的中文描述 |
total | 查询监控entity的总个数 | int | |
size | 本页返回的entity个数 | int | |
monitored_person | entity列表 | array |
上一篇
下一篇
本篇文章对您是否有帮助?