文档

设置报警消息为已读

更新时间:
一键部署

设置报警消息为已读

路径

/industry/message/alarm/setreaded

版本号

1.0.2

协议

HTTPS

请求方法

POST

是否需要用户身份鉴权

超时时间

5000

请求参数

名称

类型

是否必选

示例值

描述

letterIds

List

报警ID列表,通过queryAlarm查询返回的letterList中的letterId

appId

String

多租户sass的appid

employeeId

String

调用用户的身份Id,用于区分调用者的身份

返回数据

名称

类型

示例值

描述

code

Int

响应码, 200: 成功

message

String

错误消息

localizedMsg

String

本地语言错误消息

data

JSON

响应结果

totalCount

Long

报警消息总条数

unreadCount

Long

未读报警条数

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.2"
	},
	"params":{
		"letterIds": "value0",
		"appId": "value1",
		"employeeId": "value2"
	}
}

正常返回示例

JSON 格式

{
	"code": 200,
	"data": {
		"unreadCount": 0
	},
	"id": "fc898db03dcd44e0939fcfe5d5f4dfc2"
}

异常返回示例

JSON 格式

{
	"code": 460,
	"message": "",
	"localizedMsg": "request parameter error",
	"data": null
}

错误码

HttpCode

错误码

错误信息

描述

500

500

Internal Error

Internal Error

503

503

Service Unavailable

Service Unavailable

403

403

Request Limited

Request Limited

401

401

Empty Signature

Empty Signature

400

400

Request Format Error

Request Format Error

200

20003

Find Backend Error

Find Backend Error

200

20004

Backend Service Error

Backend Service Error

200

20055

Backend Service Invalid

Request Format Error

200

20056

Hsf Invoke Timeout

Hsf Invoke Timeout

200

401

Request Authorized Error

Request Authorized Error

200

403

Request Forbidden

Request Forbidden

200

500

Server Error

Server Error

  • 本页导读 (0)
文档反馈