围栏关系判断 最后更新时间: 2021年01月22日
简介
通过以下服务开发者可以轻松检测和判断特定终端或指定坐标与某个围栏的关系,根据此关系判断可以搭建业务预警机制等。
接口列表
接口名称 |
功能说明 |
---|---|
v1/track/geofence/status/terminal |
查询检测对象与围栏关系 |
v1/track/geofence/status/location |
查询指定坐标与围栏关系 |
查询检测对象与围栏关系
- 服务地址
URL |
https://tsapi.amap.com/v1/track/geofence/status/terminal |
请求方式 |
GET |
- 请求参数
参数名 |
含义 |
规则 |
是否必填 |
---|---|---|---|
key |
高德Key |
用户在高德地图官网申请Web服务API类型Key |
必填 |
sid |
服务唯一编号 |
sid为终端所属service唯一编号 |
必填 |
tid |
监控对象终端id |
每次只能输入1个 |
必填 |
gfids |
围栏的唯一标识 |
支持一次传入多个,以”,”分割; 单次最多支持100个,如超出将只截取前100个作为输入。 |
否; 如传入,则只判断该监控对象与 gfids 所指定的围栏的关系,不分页(忽略 page 和 pagesize 参数); 如不传,则判断该监控对象与所有绑定围栏的关系(分页返回); |
page |
查询页数 |
默认1 |
可选,默认1 |
pagesize |
每页数量 |
单页数据数量,取值 [1, 100] |
可选,默认50 |
- 返回参数
参数名 |
含义 |
备注 |
||
---|---|---|---|---|
errcode |
返回状态码 |
0代表成功,其他参考错误码说明 |
||
errmsg |
返回状态描述 |
参考错误码说明 |
||
data |
||||
count |
数据总数量 |
|||
results |
||||
gfid |
地理围栏id |
|||
gfname |
地理围栏名称 |
|||
in |
检测对象是否在围栏中 |
1:在,0:不在; 如果监控对象无位置信息,此字段填充为0 |
||
location |
检测对象当前位置 |
如果监控对象无位置信息,此字段不返回 |
||
time |
检测对象位置更新时间 |
如果监控对象无位置信息,此字段不返回 |
查询指定坐标与围栏关系
- 服务地址
URL |
https://tsapi.amap.com/v1/track/geofence/status/location |
请求方式 |
GET |
- 请求参数
参数名 |
含义 |
规则 |
是否必填 |
---|---|---|---|
key |
高德Key |
用户在高德地图官网申请Web服务API类型Key |
必填 |
sid |
服务唯一编号 |
sid为终端所属service唯一编号 |
必填 |
location |
指定坐标 |
格式:x,y |
必填 |
gfids |
围栏的唯一标识 |
支持一次传入多个,以”,”分割; 单次最多支持100个,如超出将只截取前100个作为输入。 |
否; 如传入,则只判断该坐标与 gfids 所指定的围栏的关系,不分页(忽略 page 和 pagesize 参数); 如不传,则判断该坐标与sid下的所有围栏的关系(分页返回); |
page |
查询页数 |
默认1 |
可选,默认1 |
pagesize |
每页数量 |
单页数据数量,取值 [1, 100] |
可选,默认50 |
- 返回参数
参数名 |
含义 |
备注 |
||
---|---|---|---|---|
errcode |
返回状态码 |
0代表成功,其他参考错误码说明 |
||
errmsg |
返回状态描述 |
参考错误码说明 |
||
data |
||||
count |
数据总数量 |
|||
results |
||||
gfid |
地理围栏id |
|||
gfname |
地理围栏名称 |
|||
in |
指定坐标是否在围栏中 |
1:在, 0:不在; |