查询围栏

GET

/api/v3/fence/list

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://yingyan.baidu.com/api/v3/fence/list?service_id=127980&fence_ids&ak=&sn='

响应示例

 {
    "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"
         }
    ]  

}

请求参数

Query 参数

service_id

integer

必需

service的唯一标识

示例值:

127980

monitored_person

string

可选

监控对象；1、仅填写monitored_person字段：根据监控对象删除围栏，仅适用于删除“指定entity创建的围栏”，并删除该entity上的所有围栏（兼容旧版本）。 2、仅填写fence_ids字段：根据围栏id删除（针对该service下所有entity创建的围栏，使用此方法删除） 3、二字段均填写：根据该监控对象上的指定围栏删除

示例值:

小明

fence_ids

integer

必需

围栏id列表；1、仅填写monitored_person字段：根据监控对象删除围栏，仅适用于删除“指定entity创建的围栏”，并删除该entity上的所有围栏（兼容旧版本）。 2、仅填写fence_ids字段：根据围栏id删除（针对该service下所有entity创建的围栏，使用此方法删除） 3、二字段均填写：根据该监控对象上的指定围栏删除

coord_type_output

string

可选

输出坐标类型；默认为 bd09ll。用于控制返回信息的坐标类型，可选值如下： bd09ll：百度经纬度 gcj02：国测局经纬度注：在国内（包括港、澳、台）以外区域，无论设置何种坐标系，均返回 wgs84坐标

page_index

integer

可选

分页索引；默认值：1 与page_size一起计算从第几条结果返回，代表返回第几页

page_size

integer

可选

每页返回数据量；默认值：1000 返回结果最大个数与page_index一起计算从第几条结果返回，代表返回结果中每页的围栏个数

string

必需

开发者的访问密钥，必填项。v2之前该属性为key。申请秘钥

默认值:

string

可选

可选，若开发者所用AK的校验方式为SN校验时该参数必须。

默认值:

返回响应

🟢200成功

application/json

Body

status

integer

必需

状态码;返回状态，0为成功

message

string

必需

响应信息; 对status的中文描述

total

integer

总的查询结果数量

必需

size

integer

本页返回的结果数量

必需

fences

object

围栏列表

必需

fence_id

integer

围栏唯一标识

必需

fence_name

string

围栏名称

必需

monitored_person

string

必需

围栏的监控对象;

该围栏仅监控一个entity时，返回entity_name

该围栏监控service下的所有entity时，返回#allentity

该围栏监控service下的部分entity时，返回#partofentity

shape

string

必需

围栏的形状 ; 围栏的四种形状：
circle：圆形

polygon：多边形

polyline：线型

district：行政区划

longitude

number

必需

经度; shape=circle时返回

latitude

number

必需

纬度;shape=circle时返回

radius

integer

必需

半径 ;shape=circle时返回，单位米

vertexes

array[string]

必需

多边形和线型围栏的顶点列表 ;shape=polygon或shape=polyline时返回

offset

number

必需

偏移距离 ; 仅在shape=polyline时返回偏移距离（若偏离折线距离超过该距离即报警），单位：米
如：200

coord_type

string

必需

返回的坐标类型; 仅在国外区域返回该字段，
wgs84：GPS经纬度
gcj02：国测局经纬度
bd09ll：百度经纬度

denoise

integer

必需

围栏去噪参数;单位：米

district

string

必需

行政区划描述 ;shape=district时返回

create_time

string

必需

围栏创建时间; 格式化时间。
示例： 2015-08-19 10:23:20

modify_time

string

必需

围栏修改时间 ;格式化时间。
示例： 2015-08-19 10:23:20

修改于 2022-08-22 02:54:19

增加围栏需监控的entity

查询围栏监控的所有entity