HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防系统管理模块 / 修改(字段注释参考详情接口)
修改(字段注释参考详情接口)
接口地址:https://api.iot.ink/api/app.php?s=Manage.Admin_Miniaturefirestation_Postupdate.Api
接口描述: 修改(字段注释参考详情接口)
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
address | 字符串 | 必须 | - | 示例 | |
agentPhone | 字符串 | 必须 | - | 示例 | |
areaCode | 字符串 | 必须 | - | 示例 | |
areaName | 字符串 | 必须 | - | 示例 | |
battalion | 字符串 | 必须 | - | 示例 | |
cityCode | 字符串 | 必须 | - | 示例 | |
cityName | 字符串 | 必须 | - | 示例 | |
deptId | 字符串 | 必须 | - | 示例 | |
detachment | 字符串 | 必须 | - | 示例 | |
dutyPhone | 字符串 | 必须 | - | 示例 | |
entryToolNum | 字符串 | 必须 | - | 示例 | |
fireEngineNum | 字符串 | 必须 | - | 示例 | |
fireExtinguisherNum | 字符串 | 必须 | - | 示例 | |
helmetNum | 字符串 | 必须 | - | 示例 | |
id | 字符串 | 必须 | - | 示例 | |
name | 字符串 | 必须 | - | 示例 | |
protectionSuitNum | 字符串 | 必须 | - | 示例 | |
protectiveBootsNum | 字符串 | 必须 | - | 示例 | |
provinceCode | 字符串 | 必须 | - | 示例 | |
provinceName | 字符串 | 必须 | - | 示例 | |
squadron | 字符串 | 必须 | - | 示例 | |
stationAgent | 字符串 | 必须 | - | 示例 | |
status | 字符串 | 必须 | - | 示例 | |
type | 字符串 | 必须 | - | 示例 | |
userIds | 字符串 | 必须 | - | 示例 | |
waterBandNum | 字符串 | 必须 | - | 示例 | |
waterGunNum | 字符串 | 必须 | - | 示例 | |
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
address | 必须 | |
agentPhone | 必须 | |
areaCode | 必须 | |
areaName | 必须 | |
battalion | 必须 | |
cityCode | 必须 | |
cityName | 必须 | |
deptId | 必须 | |
detachment | 必须 | |
dutyPhone | 必须 | |
entryToolNum | 必须 | |
fireEngineNum | 必须 | |
fireExtinguisherNum | 必须 | |
helmetNum | 必须 | |
id | 必须 | |
name | 必须 | |
protectionSuitNum | 必须 | |
protectiveBootsNum | 必须 | |
provinceCode | 必须 | |
provinceName | 必须 | |
squadron | 必须 | |
stationAgent | 必须 | |
status | 必须 | |
type | 必须 | |
userIds | 必须 | |
waterBandNum | 必须 | |
waterGunNum | 必须 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"address": "测试修改",
"agentPhone": "string",
"areaCode": "string",
"areaName": "string",
"battalion": "string",
"cityCode": "string",
"cityName": "string",
"deptId": 2,
"detachment": "string",
"dutyPhone": "string",
"entryToolNum": 0,
"fireEngineNum": 0,
"fireExtinguisherNum": 0,
"helmetNum": 0,
"id": 4,
"name": "测试修改",
"protectionSuitNum": 0,
"protectiveBootsNum": 0,
"provinceCode": "string",
"provinceName": "string",
"squadron": "string",
"stationAgent": "string",
"status": 0,
"type": 0,
"userIds": [
1,2,4
],
"waterBandNum": 0,
"waterGunNum": 0
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-28 13:57:24