示例中心
功能在线体验
控制台

高德 开发 猎鹰轨迹服务 开发指南 API文档 终端自定义字段

更新时间:2018年09月04日

简介

本篇介绍如何对终端的自定义字段进行管理。用户增加自定义字段后,所有属于用户指定服务的终端均可以使用这些自定义字段。用户最多可以新增5个自定义字段。

使用限制

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

增加终端的自定义字段

  • 接口说明

增加自定义字段后,所有属于当前service的终端都可以使用此自定义字段。最多增加5个自定义字段,并且这5个自定义字段都可以被检索。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/column/add

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

服务的唯一编号

不可修改,此参数用于查找service

即便填入此参数,用户也不可修改sid。

必填 

无 

 column

自定义字段名字

用户针对终端的自定义字段的名字,最多5个自定义字段

必须先在“针对终端自定义字段”中进行创建字段。

在同一个service下不能出现名称一样的自定义字段。

需要按照定义的类型上传数据,例如定义为int,则仅上传数字。

名字仅支持中文、英文大小字母、英文下划线"_"、英文横线"-"和数字

名字最长不得超过128字符,不能以"_"开头 

必填

无  

 type 

自定义字段类型

此自定义字段的类别

string

double

int 

必填 

无  

 list 

自定义字段是否可被检索

n,代表此字段不可以被检索

y,代表此字段可以被检索

此确定后不可修改 

非必填

n

  • 返回结果

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

删除终端的自定义字段

  • 接口说明

删除自定义字段后,所有属于当前service的终端下的此字段均会被删除,并且数据内容也都会被删除。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/column/delete

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

服务的唯一编号

此参数用于查找service

必填 

无 

 column

自定义字段名字

用户针对终端的自定义字段的名字,最多5个自定义字段

必须先在“针对终端自定义字段”中进行创建字段。

在同一个service下不能出现名称一样的自定义字段。

需要按照定义的类型上传数据,例如定义为int,则仅上传数字。

名字仅支持中文、英文大小字母、英文下划线"_"、英文横线"-"和数字

名字最长不得超过128字符,不能以"_"开头 

必填

无  

  • 返回结果

名称

含义

字段类型

说明

errcode

结果状态码

数值 


errmsg

返回结果状态码描述

String


errdetail

错误细节

String


修改终端的自定义字段

  • 接口说明

修改自定义字段后,所有属于当前service的终端下被修改字段都会受到影响。 

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/column/update

请求方式

POST

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

服务的唯一编号

此参数用于查找service

必填 

无 

 column

自定义字段名字

用户针对终端的自定义字段的名字,最多5个自定义字段

必须先在“针对终端自定义字段”中进行创建字段。

在同一个service下不能出现名称一样的自定义字段。

需要按照定义的类型上传数据,例如定义为int,则仅上传数字。

名字仅支持中文、英文大小字母、英文下划线"_"、英文横线"-"和数字

名字最长不得超过128字符,不能以"_"开头 

必填

无  

newcolumn

新自定义名字

同上

必填

  • 返回结果

名称

含义

字段类型

errcode

结果状态码

数值 

errmsg

返回结果状态码描述

String

errdetail

错误细节

String

查询终端的自定义字段

  • 接口说明

可以通过该接口查询已经创建的终端自定义字段。 

请注意,该接口需要使用Get形式请求。

  • URL地址

地址

http://tsapi.amap.com/v1/track/terminal/column/list

请求方式

GET

  • 请求参数

参数名

含义

规则说明

是否必须

缺省值

key

请求服务权限标识

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

必填

sid

服务的唯一编号

此参数用于查找service

必填 

无 

  • 返回结果

名称

含义

字段类型

说明

errcode

结果状态码

数值 


errmsg

返回结果状态码描述

String


errdetail

错误细节

String


data

数据结果

对象



results

里面包含具体结果

数组




column

自定义字段的名字

String




type

自定义字段的类别

String



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