示例中心
功能在线体验
控制台
您现在的位置: 开发 > 猎鹰轨迹服务 > 开发指南 > API文档 > 终端搜索 >

高德 开发 猎鹰轨迹服务 开发指南 API文档 终端搜索

更新时间:2018年11月26日

简介

本篇介绍终端搜索相关功能,猎鹰服务支持对终端的多维度搜索,具体功能有:关键字搜索、周边搜索、多边形区域内搜索、行政区域内搜索。

用量限制

 服务调用量的限制请点击这里查阅。 

关键字搜索终端

  • 接口说明

  根据关键字搜索设备,并返回实时位置。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/search

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

sid

服务ID

猎鹰服务唯一ID

keywords

要查询的关键字

可以填写需要查询的终端的设备名称,设备描述,或者设备的自定义字段内容。

filter

筛选条件

支持根据多个条件筛选,多个条件用双&符号连接。(active_time 和 inactive_time 不可同时输入)


规则:key1=value1&&key2=value2。

示例:"name=王师傅|张师傅&&lastloctime=1469817532


目前,支持的筛选字段为:

1、name: terminal_name列表,多个terminal用|分割,精确筛选。示例:" name=王师傅|张师傅"

2、lastloctime:unix时间戳,查询在此时间之后有定位信息上传的terminal(相当于查询设备位置的lastloctime>=active_time的设备)。示例:" lastloctime>=1469817532"

或查询在此时间之后无定位信息上传的terminal(相当于查询设备位置的lastloctime<inactive_time的设备)。示例:" lastloctime <1469817532"

3、开发者自定义的terminal属性字段,一个自定义字段对应一个Key。

sortrule

排序规则

默认值:name:asc(按 terminal_name 升序排序)


只支持按一个字段排序,支持的排序字段如下:

1、lastloctime:设备的最后定位时间

2、name:terminal 唯一标识

3、<custom-key>:开发者自定义的设备属性字段


【使用规则】

sortrule=字段名:asc (升序)

sortrule=字段名:desc (降序)


【示例】

按定位时间loc_time字段降序排序:sortrule=lastloctime:desc

page

页码

需要第几页数据

1

pagesize

每页返回结果数

 每页返回点的个数,必须说明page=1的时候起点、终点的个数不计算在内。pagesize最大值100 

50

  • 返回结果

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

data




count

返回结果数统计

数值


results

返回结果数据集

数组



name

终端名字

String



tid

终端设备id

数值



desc

终端的描述

String



createtime

此终端创立时间,用Unix时间戳表示,需要精准到毫秒

数值



locatetime

此设备最后一次的定位时间点,用Unix时间戳表示

若一直未上传轨迹点则返回null

数值



location

设备最后的位置点

对象




latitude

纬度

double




longitude

经度

double




speed

速度。允许出现小数,但是小数点后最多3位,单位 km/h

double




direction

方向。小数点后最多4位

取值范围:[0,359],0代表正北方,采用顺时针方向取值

double




height

高度。允许出现小数,但是小数点后最多3位,单位 米

double




accuracy

定位精准度。仅允许输入数字;允许输入小数但小数点后最多3位

double




<key-value-track>

开发者针对轨迹自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义



props

用户自定义的设备字段

对象




<key-value-terminal>

开发者针对终端自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义

周边搜索终端

  • 接口说明

  根据圆心半径搜索设备,并返回实时位置。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/aroundsearch

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

sid

服务ID

猎鹰服务唯一ID

center

中心点

经纬度,string类型。格式为:纬度,经度

示例:36.10,116.33

radius

半径

int类型。单位:米,取值范围[1,5000]

示例:1000

500

filter

筛选条件

支持根据多个条件筛选,多个条件用双&符号连接。(active_time 和 inactive_time 不可同时输入)


规则:key1=value1&&key2=value2。

示例:"name=王师傅|张师傅&&lastloctime=1469817532


目前,支持的筛选字段为:

1、name: terminal_name列表,多个terminal用|分割,精确筛选。示例:" name=王师傅|张师傅"

2、lastloctime:unix时间戳,查询在此时间之后有定位信息上传的terminal(相当于查询设备位置的lastloctime>=active_time的设备)。示例:" lastloctime>=1469817532"

或查询在此时间之后无定位信息上传的terminal(相当于查询设备位置的lastloctime<inactive_time的设备)。示例:" lastloctime <1469817532"

3、开发者自定义的terminal属性字段,一个自定义字段对应一个Key。

sortrule

排序规则

默认值:name:asc(按 terminal_name 升序排序)


只支持按一个字段排序,支持的排序字段如下:

1、lastloctime:设备的最后定位时间

2、name:terminal 唯一标识

3、<custom-key>:开发者自定义的设备属性字段


【使用规则】

sortrule=字段名:asc (升序)

sortrule=字段名:desc (降序)


【示例】

按定位时间loc_time字段降序排序:sortrule=lastloctime:desc

page

页码

需要第几页数据

1

pagesize

每页返回结果数

 每页返回点的个数,必须说明page=1的时候起点、终点的个数不计算在内。pagesize最大值100 

50

  • 返回结果

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

data




count

返回结果数统计

数值


results

返回结果数据集

数组



name

终端名字

String



tid

终端设备id

数值



desc

终端的描述

String



createtime

此终端创立时间,用Unix时间戳表示,需要精准到毫秒

数值



locatetime

此设备最后一次的定位时间点,用Unix时间戳表示

若一直未上传轨迹点则返回null

数值



location

设备最后的位置点

对象




latitude

纬度

double




longitude

经度

double




speed

速度。允许出现小数,但是小数点后最多3位,单位 km/h

double




direction

方向。小数点后最多4位

取值范围:[0,359],0代表正北方,采用顺时针方向取值

double




height

高度。允许出现小数,但是小数点后最多3位,单位 米

double




accuracy

定位精准度。仅允许输入数字;允许输入小数但小数点后最多3位

double




distance

离中心点距离,单位米。仅当在周边搜索时候返回。

数值




<key-value-track>

开发者针对轨迹自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义



props

用户自定义的设备字段

对象




<key-value-terminal>

开发者针对终端自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义

多边形区域内搜索终端

  • 接口说明

  根据圈定的多边形范围检索设备,并返回实时位置。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/polygonsearch

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

sid

服务ID

猎鹰服务唯一ID

polygon

多边形区域范围

参数是string类型

格式规则: 经纬度顺序为:纬度,经度; 顶点顺序可按顺时针或逆时针排列。 多边形外接矩形面积不超过3000平方公里;支持一次圈定多个多边形,多个多边形外接矩形面积总和不超过3000平方公里;例如:“double,double;double,double; ...;double,double|double,double… double,double”;分割两组经纬度,|分割两个多边形。

filter

筛选条件

支持根据多个条件筛选,多个条件用双&符号连接。(active_time 和 inactive_time 不可同时输入)


规则:key1=value1&&key2=value2。

示例:"name=王师傅|张师傅&&lastloctime=1469817532


目前,支持的筛选字段为:

1、name: terminal_name列表,多个terminal用|分割,精确筛选。示例:" name=王师傅|张师傅"

2、lastloctime:unix时间戳,查询在此时间之后有定位信息上传的terminal(相当于查询设备位置的lastloctime>=active_time的设备)。示例:" lastloctime>=1469817532"

或查询在此时间之后无定位信息上传的terminal(相当于查询设备位置的lastloctime<inactive_time的设备)。示例:" lastloctime <1469817532"

3、开发者自定义的terminal属性字段,一个自定义字段对应一个Key。

sortrule

排序规则

默认值:name:asc(按 terminal_name 升序排序)


只支持按一个字段排序,支持的排序字段如下:

1、lastloctime:设备的最后定位时间

2、name:terminal 唯一标识

3、<custom-key>:开发者自定义的设备属性字段


【使用规则】

sortrule=字段名:asc (升序)

sortrule=字段名:desc (降序)


【示例】

按定位时间loc_time字段降序排序:sortrule=lastloctime:desc

page

页码

需要第几页数据

1

pagesize

每页返回结果数

 每页返回点的个数,必须说明page=1的时候起点、终点的个数不计算在内。pagesize最大值100 

50

  • 返回结果

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

data




count

返回结果数统计

数值


results

返回结果数据集

数组



name

终端名字

String



tid

终端设备id

数值



desc

终端的描述

String



createtime

此终端创立时间,用Unix时间戳表示,需要精准到毫秒

数值



locatetime

此设备最后一次的定位时间点,用Unix时间戳表示

若一直未上传轨迹点则返回null

数值



location

设备最后的位置点

对象




latitude

纬度

double




longitude

经度

double




speed

速度。允许出现小数,但是小数点后最多3位,单位 km/h

double




direction

方向。小数点后最多4位

取值范围:[0,359],0代表正北方,采用顺时针方向取值

double




height

高度。允许出现小数,但是小数点后最多3位,单位 米

double




accuracy

定位精准度。仅允许输入数字;允许输入小数但小数点后最多3位

double




<key-value-track>

开发者针对轨迹自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义



props

用户自定义的设备字段

对象




<key-value-terminal>

开发者针对终端自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义

行政区域内搜索终端

  • 接口说明

根据行政区划关键字检索设备,并返回实时位置。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/districtsearch

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

sid

服务ID

猎鹰服务唯一ID

keywords

关键字

参数是string类型

支持中国范围内的国家、省、市、区/县名称和adcode。


关键字示例: 北京市、朝阳区、110000


注意:遇到行政区划是两块区域的需要将两块区域全部返回。

filter

筛选条件

支持根据多个条件筛选,多个条件用双&符号连接。(active_time 和 inactive_time 不可同时输入)


规则:key1=value1&&key2=value2。

示例:"name=王师傅|张师傅&&lastloctime=1469817532


目前,支持的筛选字段为:

1、name: terminal_name列表,多个terminal用|分割,精确筛选。示例:" name=王师傅|张师傅"

2、lastloctime:unix时间戳,查询在此时间之后有定位信息上传的terminal(相当于查询设备位置的lastloctime>=active_time的设备)。示例:" lastloctime>=1469817532"

或查询在此时间之后无定位信息上传的terminal(相当于查询设备位置的lastloctime<inactive_time的设备)。示例:" lastloctime <1469817532"

3、开发者自定义的terminal属性字段,一个自定义字段对应一个Key。

sortrule

排序规则

默认值:name:asc(按 terminal_name 升序排序)


只支持按一个字段排序,支持的排序字段如下:

1、lastloctime:设备的最后定位时间

2、name:terminal 唯一标识

3、<custom-key>:开发者自定义的设备属性字段


【使用规则】

sortrule=字段名:asc (升序)

sortrule=字段名:desc (降序)


【示例】

按定位时间loc_time字段降序排序:sortrule=lastloctime:desc

page

页码

需要第几页数据

1

pagesize

每页返回结果数

 每页返回点的个数,必须说明page=1的时候起点、终点的个数不计算在内。pagesize最大值100 

50

  • 返回结果

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

data




count

返回结果数统计

数值


results

返回结果数据集

数组



name

终端名字

String



tid

终端设备id

数值



desc

终端的描述

String



createtime

此终端创立时间,用Unix时间戳表示,需要精准到毫秒

数值



locatetime

此设备最后一次的定位时间点,用Unix时间戳表示

若一直未上传轨迹点则返回null

数值



location

设备最后的位置点

对象




latitude

纬度

double




longitude

经度

double




speed

速度。允许出现小数,但是小数点后最多3位,单位 km/h

double




direction

方向。小数点后最多4位

取值范围:[0,359],0代表正北方,采用顺时针方向取值

double




height

高度。允许出现小数,但是小数点后最多3位,单位 米

double




accuracy

定位精准度。仅允许输入数字;允许输入小数但小数点后最多3位

double




<key-value-track>

开发者针对轨迹自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义



props

用户自定义的设备字段

对象




<key-value-terminal>

开发者针对终端自定义的字段,返回此字段和内容。

key代表名字

value代表内容

用户自定义


示例中心 功能
在线体验
常见问题