中科图灵开放平台 / 智慧消防设备管理模块 / 获取告警通知列表

获取告警通知列表

接口描述: 获取告警通知列表

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

接口参数

参数名字类型是否必须默认值其他说明
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
                }
            ]
        }
    ]
}
失败响应返回示例:

错误列表

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

本文档生成时间:2024-04-23 20:15:43