HTTP/HTTPS
请求协议
中科图灵开放平台 / 智慧消防设备管理模块 / 获取告警通知列表
获取告警通知列表
接口地址:https://api.iot.ink/api/app.php?s=Equipment.Device_WarnNotice_GetlistWarnNotice.Api
接口描述: 获取告警通知列表
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
deptId | 整型 | 必须 | - | 单位id 示例 | |
apiRequestRaw | 字符串 | 可选 | - | ||
headerInfo | 字符串 | 可选 | - | [] |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.code | 字符串 | |
data.msg | 字符串 | |
data.data | 数组 | |
data.data>>id | 整型 | 报警通知id |
data.data>>level | 整型 | 报警通知级别 |
data.data>>receiptStartTime | 字符串 | 开始接收时间 |
data.data>>receiptEndTime | 字符串 | 结束接收时间 |
data.data>>intervals | 字符串 | 接收频率 |
data.data>>deptId | 字符串 | 单位id |
data.data>>tenantId | 字符串 | |
data.data>>createTime | 字符串 | |
data.data>>delFlag | 字符串 | |
data.data>>userList | 数组 | |
data.data>>userList>>userId | 字符串 | 接收报警用户id |
data.data>>userList>>username | 字符串 | 用户名称 |
data.data>>userList>>password | 字符串 | |
data.data>>userList>>createTime | 字符串 | |
data.data>>userList>>updateTime | 字符串 | |
data.data>>userList>>delFlag | 字符串 | |
data.data>>userList>>lockFlag | 字符串 | |
data.data>>userList>>avatar | 字符串 | |
data.data>>userList>>deptId | 字符串 | |
data.data>>userList>>tenantId | 字符串 | |
data.data>>userList>>wxOpenid | 字符串 | |
data.data>>userList>>qqOpenid | 字符串 | |
data.data>>userList>>giteeLogin | 字符串 | |
data.data>>userList>>oscId | 字符串 | |
data.data>>userList>>departmentId | 字符串 | |
data.data>>userList>>realName | 字符串 | |
data.data>>userList>>phone | 字符串 | |
data.data>>userList>>isTenantAdmin | 字符串 | |
data.data>>pushTypeList | 数组 | |
data.data>>pushTypeList>>id | 字符串 | |
data.data>>pushTypeList>>warnNoticeId | 字符串 | |
data.data>>pushTypeList>>type | 字符串 | 推送类型 |
data.data>>pushTypeList>>tenantId | 字符串 | |
data.data>>pushTypeList>>createTime | 字符串 | |
data.data>>weekList | 数组 | |
data.data>>weekList>>id | 字符串 | |
data.data>>weekList>>warnNoticeId | 字符串 | |
data.data>>weekList>>weeks | 字符串 | 推送时间(星期) |
data.data>>weekList>>tenantId | 字符串 | |
data.data>>weekList>>createTime | 字符串 | |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
deptId | 必须 | |
apiRequestRaw | 可选 | |
headerInfo | 可选 |
客户端请求示例
成功响应返回示例:
{
"code": 0,
"msg": null,
"data": [
{
"id": 5,
"level": 1,
"receiptStartTime": "13:10",
"receiptEndTime": "21:15",
"intervals": 1800,
"deptId": 2,
"tenantId": 1,
"createTime": "2020-06-08 18:26:45",
"delFlag": "0",
"userList": [
{
"userId": 1,
"username": "admin",
"password": "$2a$10$8zs/wEcmB03eyW.exiKzZOAFlh/Hln7FYko2tXTReEp9pxqYziPwS",
"createTime": "2018-04-20 07:15:18",
"updateTime": "2020-06-02 14:54:28",
"delFlag": "0",
"lockFlag": "0",
"avatar": "Turing-52328736c020449b8c18a474b5689d5b.jpg",
"deptId": 2,
"tenantId": 1,
"wxOpenid": "o_0FT0uyg_H1vVy2H0JpSwlVGhWQ",
"qqOpenid": null,
"giteeLogin": "log4j",
"oscId": "2303656",
"departmentId": null,
"realName": "",
"phone": "17034642889",
"isTenantAdmin": 1
}
],
"pushTypeList": [
{
"id": 9,
"warnNoticeId": null,
"type": 1,
"tenantId": null,
"createTime": null
}
],
"weekList": [
{
"id": 11,
"warnNoticeId": null,
"weeks": 1,
"tenantId": null,
"createTime": null
}
]
},
{
"id": 6,
"level": 2,
"receiptStartTime": "08:15",
"receiptEndTime": "18:25",
"intervals": 600,
"deptId": 2,
"tenantId": 1,
"createTime": "2020-06-09 15:03:19",
"delFlag": "0",
"userList": [
{
"userId": 1,
"username": "admin",
"password": "$2a$10$8zs/wEcmB03eyW.exiKzZOAFlh/Hln7FYko2tXTReEp9pxqYziPwS",
"createTime": "2018-04-20 07:15:18",
"updateTime": "2020-06-02 14:54:28",
"delFlag": "0",
"lockFlag": "0",
"avatar": "Turing-52328736c020449b8c18a474b5689d5b.jpg",
"deptId": 2,
"tenantId": 1,
"wxOpenid": "o_0FT0uyg_H1vVy2H0JpSwlVGhWQ",
"qqOpenid": null,
"giteeLogin": "log4j",
"oscId": "2303656",
"departmentId": null,
"realName": "",
"phone": "17034642889",
"isTenantAdmin": 1
}
],
"pushTypeList": [
{
"id": 13,
"warnNoticeId": null,
"type": 1,
"tenantId": null,
"createTime": null
}
],
"weekList": [
{
"id": 21,
"warnNoticeId": null,
"weeks": 1,
"tenantId": null,
"createTime": null
}
]
}
]
}
失败响应返回示例:
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
409 | ret=409,接口流量不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-23 20:15:43