地理围栏报警

简介

围栏状态和报警信息查询类接口,包括以下5个接口:

模块 接口名称 功能说明
fence querystatus 查询监控对象在围栏内或外
historyalarm 查询某监控对象的历史报警信息
batchhistoryalarm 批量查询某 service 下时间段以内的所有报警信息,用于服务端报警同步

注:鹰眼 v3.0使用全新域名http://yingyan.baidu.com/api/v3,请开发者注意。

坐标系说明

目前中国主要有以下三种坐标系:


WGS84:为一种大地坐标系,也是目前广泛使用的GPS全球卫星定位系统使用的坐标系。


GCJ02:是由中国国家测绘局制订的地理信息系统的坐标系统。由WGS84坐标系经加密后的坐标系。


BD09:为百度坐标系,在GCJ02坐标系基础上再次加密。其中bd09ll表示百度经纬度坐标,bd09mc表示百度墨卡托米制坐标


非中国地区地图,统一使用WGS84坐标


鹰眼 Web服务API v3.0的默认输入输出参数为百度坐标(BD09),同时可通过"coord_type","coord_type_input","coord_type_output"(以各服务参数介绍为准)控制输入输出的坐标类型,鹰眼将自动完成转换。

querystatus——查询监控对象在围栏内或外

接口说明

查询监控对象在围栏内或外

请求URI

http://yingyan.baidu.com/api/v3/fence/querystatus

HTTP请求方式

GET

请求参数

参数名 参数含义 类型 是否必填 备注
ak 用户的ak string
service_id service的ID,service 的唯一标识。 int
在轨迹管理台创建鹰眼服务时,系统返回的 service_id


monitored_person 监控对象的 entity_name string(128)


fence_ids 围栏实体的id列表 “int,int…” 若不填,则查询监控对象上的所有围栏状态

返回参数

参数名 参数含义 类型 备注
status 状态码 int 返回状态,0为成功
message 响应信息 string 对status的中文描述
size 返回结果的数量 int
monitored_statuses 报警的数量 array
fence_id 围栏 id int
monitored_status 状态 string unknown:未知状态

in:在围栏内

out:在围栏外

请求示例

http://yingyan.baidu.com/api/v3/fence/querystatus?service_id=100000&monitored_person=小明&fence_ids=1,2,3&ak=开发者的ak

返回示例

JSON
{
 "status": 0,
 "message": "成功",
 "size": 2,
 "monitored_statuses": [
   {
     "fence_id": 2,
     "monitored_status": "in"
   },
   {
     "fence_id": 3,
     "monitored_status": "unknown"
   }
 ]

}

historyalarm—— 查询某监控对象的围栏报警信息

接口说明

查询围栏的监控对象7天以内(包含7天)的围栏报警信息,7天以外的报警信息将被删除。

注:即使围栏或监控对象已被删除,仍能根据 fence_id 和 monitored_person 查询7天之内的报警信息。

请求URI

http://yingyan.baidu.com/api/v3/fence/historyalarm

HTTP请求方式

GET

请求参数

参数名 参数含义 类型 是否必填 备注
ak 用户的ak string
service_id service的ID,service 的唯一标识。 int
在轨迹管理台创建鹰眼服务时,系统返回的 service_id


monitored_person 监控对象的 entity_name string(128)
fence_ids 围栏实体的id列表 “int,int…” 若不填,则查询监控对象所有围栏的报警信息
start_time 开始时间 UNIX 时间戳 若不填,则返回7天内所有报警信息
end_time 结束时间 UNIX 时间戳 若不填,则返回7天内所有报警信息
coord_type_output 返回坐标类型 string 默认为 bd09ll。

用于控制返回结果的坐标类型

可选值如下:

bd09ll:百度经纬度

gcj02:国测局经纬度

注:国外均返回 wgs84 坐标

返回参数

参数名 参数含义 类型 备注
status 状态码 int 返回状态,0为成功
message 响应信息 string 对status的中文描述
size 返回结果的数量 int
alarms 报警的数量 array
fence_id 围栏 id,唯一标识符 int
fence_name 围栏的名称 string
monitored_person 监控对象 string
action 触发动作 string 可能的返回值:

enter:进入围栏

exit:离开围栏

alarm_point 触发围栏报警轨迹点
longitude 监控对象触发围栏时的经度 double
latitude 监控对象触发围栏时的纬度 double
radius 定位精度 int 单位:米
coord_type 返回的坐标类型 string 仅在国外区域返回该字段,返回值为:wgs84
loc_time 围栏实际触发时间,即触发围栏报警的轨迹点的定位时间 UNIX 时间戳 即使触发围栏的轨迹点未实时上传,由于轨迹点中携带了 loc_time,鹰眼仍能根据 loc_time判断围栏实际触发时间。
create_time 服务端接收到报警信息的时间 UNIX 时间戳 由于鹰眼 API 围栏为服务端围栏,即只有当轨迹点上传鹰眼服务端时,才能进行围栏触发判断。因此服务端接收到报警的时间可能由于轨迹点上传的不及时性,而晚于围栏实际触发时间 loc_time。例如,轨迹点实际触发围栏时间为13:00,但若由于各种原因,轨迹点上传至服务端进行围栏计算的时间为14:00,则该报警的 create_time为14:00。
pre_point 触发围栏报警轨迹点的上一个轨迹点
longitude 监控对象触发围栏时的经度 double
latitude 监控对象触发围栏时的纬度 double
radius 定位精度 int 单位:米
coord_type 返回的坐标类型 string 仅在国外区域返回该字段,返回值为:wgs84
loc_time 围栏实际触发时间,即触发围栏报警的轨迹点的定位时间 UNIX 时间戳 即使触发围栏的轨迹点未实时上传,由于轨迹点中携带了 loc_time,鹰眼仍能根据 loc_time判断围栏实际触发时间。
create_time 服务端接收到报警信息的时间 UNIX 时间戳 由于鹰眼 API 围栏为服务端围栏,即只有当轨迹点上传鹰眼服务端时,才能进行围栏触发判断。因此服务端接收到报警的时间可能由于轨迹点上传的不及时性,而晚于围栏实际触发时间 loc_time。例如,轨迹点实际触发围栏时间为13:00,但若由于各种原因,轨迹点上传至服务端进行围栏计算的时间为14:00,则该报警的 create_time为14:00。

请求示例

http://yingyan.baidu.com/api/v3/fence/historyalarm?service_id=127980&monitored_person=小明&fence_ids=1&start_time=1489420800&end_time=1489507200&ak=开发者的ak

返回示例

JSON
{
   "status": 0,
   "size": 1,
   "message": "成功",
   " alarms ": [
       {
           "fence_id": 1,
           "fence_name":"围栏名称",
           "monitored_person":"entity1",
           "action": "exit", 
           "alarm_point":{
            
               "longitude":116.2333,
               "latitude":43.892,
               "radius":27,
               "loc_time": 1419388604
               "create_time": 1419388609
             },
           "pre_point":{
               "longitude":116.2367,
               "latitude":43.894,
               "radius":28,
               "loc_time": 1419388724
               "create_time": 1419388729
             }           
       }
   ]

}

batchhistoryalarm—— 批量同步某 service的围栏报警信息

接口说明

批量同步某时间段内 service 所有围栏的报警信息。

注:即使围栏或监控对象已被删除,仍能同步7天之内这些围栏的报警信息。

请求URI

http://yingyan.baidu.com/api/v3/fence/batchhistoryalarm

HTTP请求方式

GET

请求参数

参数名 参数含义 类型 是否必填 备注
ak 用户的ak string
service_id service的ID,service 的唯一标识。 int 在轨迹管理台创建鹰眼服务时,系统返回的 service_id
start_time 开始时间 UNIX 时间戳 查询的时间是服务端接收到报警的时间,即报警信息的 create_time。例如,轨迹点实际触发围栏时间为13:00,但若由于各种原因,轨迹点上传至服务端进行围栏计算的时间为14:00,则该报警的 create_time为14:00。
end_time 结束时间 UNIX 时间戳 结束时间需大于开始时间,但不可超过1小时。即每次请求,最多只能同步1个小时时长的报警信息。
coord_type_output 返回坐标类型 string 默认为 bd09ll。

用于控制返回结果的坐标类型

可选值如下:

bd09ll:百度经纬度

gcj02:国测局经纬度

注:国外均返回 wgs84 坐标

page_index 分页索引 int(1到2^32-1) 可选 默认值为1。page_index与page_size一起计算从第几条结果返回,代表返回第几页。
page_size 分页大小 int(1-1000) 可选 默认值为500。page_size与page_index一起计算从第几条结果返回,代表返回结果中每页有几条记录。

返回参数

参数名 参数含义 类型 备注
status 状态码 int 返回状态,0为成功
message 响应信息 string 对status的中文描述
total 符合条件的总报警数 int
size 本页返回的结果条数 int
alarms 报警的数量 array
fence_id 围栏 id,唯一标识符 int
fence_name 围栏的名称 string
monitored_person 监控对象 string
action 触发动作 string 可能的返回值:

enter:进入围栏

exit:离开围栏

alarm_point 触发围栏报警轨迹点
longitude 监控对象触发围栏时的经度 double
latitude 监控对象触发围栏时的纬度 double
radius 定位精度 int 单位:米
coord_type 返回的坐标类型 string 仅在国外区域返回该字段,返回值为:wgs84
loc_time 围栏实际触发时间,即触发围栏报警的轨迹点的定位时间 UNIX 时间戳 即使触发围栏的轨迹点未实时上传,由于轨迹点中携带了 loc_time,鹰眼仍能根据 loc_time判断围栏实际触发时间。
create_time 服务端接收到报警信息的时间 UNIX 时间戳 由于鹰眼 API 围栏为服务端围栏,即只有当轨迹点上传鹰眼服务端时,才能进行围栏触发判断。因此服务端接收到报警的时间可能由于轨迹点上传的不及时性,而晚于围栏实际触发时间 loc_time。例如,轨迹点实际触发围栏时间为13:00,但若由于各种原因,轨迹点上传至服务端进行围栏计算的时间为14:00,则该报警的 create_time为14:00。
pre_point 触发围栏报警轨迹点的上一个轨迹点
longitude 监控对象触发围栏时的经度 double
latitude 监控对象触发围栏时的纬度 double
radius 定位精度 int 单位:米
coord_type 返回的坐标类型 string 仅在国外区域返回该字段,返回值为:wgs84
loc_time 围栏实际触发时间,即触发围栏报警的轨迹点的定位时间 UNIX 时间戳 即使触发围栏的轨迹点未实时上传,由于轨迹点中携带了 loc_time,鹰眼仍能根据 loc_time判断围栏实际触发时间。
create_time 服务端接收到报警信息的时间 UNIX 时间戳 由于鹰眼 API 围栏为服务端围栏,即只有当轨迹点上传鹰眼服务端时,才能进行围栏触发判断。因此服务端接收到报警的时间可能由于轨迹点上传的不及时性,而晚于围栏实际触发时间 loc_time。例如,轨迹点实际触发围栏时间为13:00,但若由于各种原因,轨迹点上传至服务端进行围栏计算的时间为14:00,则该报警的 create_time为14:00。

请求示例

http://yingyan.baidu.com/api/v3/fence/batchhistoryalarm?&service_id=127980&start_time=1489420800&end_time=1489424400&ak=开发者的ak

返回示例

JSON
{
   "status": 0,
   "total": 2000,
   "size": 500,
   "message": "成功",
   " alarms ": [
       {
           "fence_id": 1,
           "fence_name":"学校",
           "monitored_person":"小明",
           "action": "exit", 
           "alarm_point":{
            
               "longitude":116.2333,
               "latitude":43.892,
               "radius":27,
               "loc_time": 1419388604
               "create_time": 1419388609
             },
           "pre_point":{
               "longitude":116.2367,
               "latitude":43.894,
               "radius":28,
               "loc_time": 1419388724
               "create_time": 1419388729
             }                
       },
      {
           "fence_id": 1,
           "fence_name":" 学校",
           "monitored_person":"小明",
           "action": "enter", 
           "alarm_point":{           
               "longitude":116.2333,
               "latitude":43.892,
               "radius":12,
               "loc_time": 1419387405,
               "create_time": 1419387405
             }, 
            "pre_point": {
               "longitude":116.2367,
               "latitude":43.894,
               "radius":15,
               "loc_time": 1419387465,
               "create_time": 1419387465
             }           
       }
   ]

}