接口约定

时间约定

所有的时间均为UTC时间

返回值

返回值是一个Json对象,包括如下三部分内容:

字段名 含义
code状态码0,调用成功,调用结果符合预期
非0,调用失败,调用结果不符合预期
message信息详情code 非0 的时候,会返回一段文字描述,对code 进行说明。
data返回的数据code 为0 的时候,data 是实际的返回数据。data 的类型可以是对象(复合类型)或者基本类型(数字、字符串)
code 非0 的时候,data不返回。
状态码
code 说明
22003参数错误
99999系统错误
分页约定
参数说明
pageNo如果未指定或指定的值小于等于0,则置为1;
pageSize(1)如果未指定或指定的值小于等于0,则置为20
(2)如果指定的值大于2000,则置为2000
返回值示例{"code":0,"data":{"list":[...],"pageNo":1,"pageSize":20,"totalItems":251}}
字段有效性校检约定
区域行政名称校验

接口中出现省、市、区/县属性时,只接受合法的行政区域名称,直辖市如:上海市,上海,长宁区;普通省份如:河南省,郑州市,中牟县。

服务实例状态

服务实例状态属性(status)取值范围如下:

(1)INACTIVE:未激活

(2)INSERVICE:服务中

(3)PAUSE:暂停

(4)CLOSE:关停

激活方式

激活方式属性取值范围如下:

(1)MANUAL:服务器端手动激活

(2)CONNECT:连接时自动激活

建筑物类型

建筑物类型属性(type)取值如下:

(1)HOUSE:房屋

(2)LANDSLIP:滑坡

(3)SIDESLOP:边坡

(4)IRONTOWER:铁塔

(5)ELECTRICTOWER:电力塔

(6)SIGNALTOWER:信号塔

(7)DIKE:大坝

(8)FACTORYBUILDING:厂房

(9)ROLLINGSTONE:滚石