中科图灵开放平台 / 智慧消防设备管理模块 / 添加消火栓

添加消火栓

接口描述: 添加消火栓

HTTP/HTTPS
请求协议
POST
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
name字符串必须-消火栓名称 示例消火栓01
provinceCode字符串必须-所在省份code 示例420000
cityCode字符串必须-所在城市code 示例420100
areaCode字符串必须-所在区域code 示例420115
provinceName字符串必须-所在城市 示例湖北省
cityName字符串必须-所在区域 示例武汉市
areaName字符串必须-所在区域 示例江夏区
radius整型必须-保护半径(单位:m) 示例10
sign字符串必须-是否标记--经纬度 (是=1,否=0) 示例1
latLud字符串必须-经纬度 --- 标记为 1 时必填 示例30.462802,30.462802
type字符串可选-消火栓类型(1=地下式,2=地上式,3=直埋伸缩) 示例1
outletType字符串必须-出水口(1=单口式,2=双口式,3=三出水口式) 示例1
firstOutletType字符串可选-第一出水口类型(1=外螺旋式,2=内扣式) --出水口为 1 2 3必填 示例1
firstOutletRadius整型可选-第一出水口半径(单位:mm) --出水口为 1 2 3必填 示例200
secondOutletType字符串可选-第二出水口类型(1=外螺旋式,2=内扣式) --出水口为 2 3必填 示例
secondOutletRadius整型可选-第二出水口半径(单位:mm) --出水口为 2 3必填 示例
thirdOutletType字符串可选-第三出水口类型(1=外螺旋式,2=内扣式)--出水口为 3必填 示例
thirdOutletRadius整型可选-第三出水口半径(单位:mm) --出水口为 3必填 示例
pipelineType字符串可选-水管道(1=高压给水,2=临时高压给水,3=低压给水) 示例
address字符串可选-详细地址 示例金融港
deviceId字符串可选-绑定设备id 示例
apiRequestRaw字符串可选-
headerInfo字符串可选-[]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.code字符串
data.msg字符串
data.data字符串
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
name 必须
provinceCode 必须
cityCode 必须
areaCode 必须
provinceName 必须
cityName 必须
areaName 必须
radius 必须
sign 必须
latLud 必须
type 可选
outletType 必须
firstOutletType 可选
firstOutletRadius 可选
secondOutletType 可选
secondOutletRadius 可选
thirdOutletType 可选
thirdOutletRadius 可选
pipelineType 可选
address 可选
deviceId 可选
apiRequestRaw 可选
headerInfo 可选

客户端请求示例

成功响应返回示例:
{
    "code": 0,
    "msg": null,
    "data": null
}
失败响应返回示例:

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
500表示服务端内部错误

本文档生成时间:2024-04-28 12:12:13