HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防设备管理模块 / 添加消火栓
添加消火栓
接口地址:https://api.iot.ink/api/app.php?s=Equipment.Device_FireHydrant_Postadd.Api
接口描述: 添加消火栓
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
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
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-28 12:12:13