泰山数字身份统一认证与管控平台（TSIAM）

# 数字纪检监察门户统一待办对接集成规范

# 历次修改内容

2023年6月27日18:27 将参数appcode改为了appCode

# 1 接口说明

建议使用post请求,Content-Type为multipart/form-data形式的

TYPE Content-Type SupportOrNot
GET 不支持
post application/x-www-form-urlencoded 不支持
post application/json 不支持
post multipart/form-data 支持

# postman实例

20230626155748404

# 1.1 新增待办接口

# 1.1.1接口地址

ip:port/taishanApi/todoApi/addTodoData
1

# 1.1.2传递参数

参数名称 参数说明 类型 数据格式/说明 必填 长度
appCode 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
appSecret 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
todoId 待办唯一值 varchar 待办唯一值 是 50
title 标题 varchar 待办工作的标题，主题 是 500
releaseTime 发布时间 varchar yyyy-MM-dd HH:mm:ss 是
jumpUrl 跳转地址 varchar /context-path/a/b?todoId=123
在查看详情时候进行各应用跳转 。
ip和端口门户系统自动补充		 是 500
deptCode 发布部门code varchar 推送待办的部门code 是 50
deptName 发布部门名称 varchar 推送待办的部门name 是 200
senderName 待办的发布人姓名 varchar 推送人姓名 是 50
senderEname 待办的发布人账号 varchar 推送人账号或邮箱,暂时还未完全确定 是 50
undertakeName 承办人姓名 varchar 承办人姓名 是 50
undertakeEname 承办人账号 varchar 承办人账号或邮箱,暂时还未完全确定 是 50
todoType 待办类型 varchar 根据业务决定例如:审理待办,处置待办等 是 20
messageType 消息类型 varchar 消息类型 01 业务待办 02 便函 03通知公告 04日程安排 是 2

# 1.1.3返回参数

参数名称 类型 说明
code int 枚举服务器响应代码,成功为200
data object 接口返回的业务数据
└─ownCode int 业务返回编码,成功为200
└─innerMessage String 业务返回内部消息
└─message String 业务返回消息
└─checkResultEntity object 业务数据校验未通过返回的结果
message String 枚举所有的服务器响应成功或者失败的详细信息
success boolean 枚举所有的服务器响应状态

# 1.1.4返回实例

# 1.1.4.1 成功
{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 200,
        "innerMessage": "",
        "message": "成功"
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
# 1.1.4.2 失败

其中target为请求数据的唯一id

{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 201,
        "innerMessage": "",
        "message": "校验未通过",
        "checkResultEntity": {
            "checkItemEntityList": [
                {
                    "code": 2002,
                    "fieldName": "消息类型",
                    "fieldEName": "messageType",
                    "message": "长度不符合规定最大长度:2",
                    "value": "011",
                    "isSuccess": false
                }
            ],
            "isSuccess": false,
            "target": "1efa90cef63ef13c93887260e3c39212"
        }
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 202,
        "innerMessage": "",
        "message": "已存在该唯一值数据!",
        "todoId": "1efa90cef63ef13c93887260e3c39212"
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12

# 1.2 更新待办接口

# 1.2.1接口地址

ip:port/taishanApi/todoApi/updateTodoData
1

# 1.2.2传递参数

参数名称 参数说明 类型 数据格式/说明 必填 长度
appCode 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
appSecret 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
todoId 待办唯一值 varchar 待办唯一值 是 50
dealtime 处置时间 varchar yyyy-MM-dd HH:mm:ss 是
todoState 待办状态 varchar 01待办02已办 不传参默认02已办 否 2

# 1.2.3返回参数

参数名称 类型 说明
code int 枚举服务器响应代码,成功为200
data object 接口返回的业务数据
└─ownCode int 业务返回编码,成功为200
└─innerMessage String 业务返回内部消息
└─message String 业务返回消息
└─checkResultEntity object 业务数据校验未通过返回的结果
message String 枚举所有的服务器响应成功或者失败的详细信息
success boolean 枚举所有的服务器响应状态

# 1.2.4返回实例

# 1.2.4.1 成功
{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 200,
        "innerMessage": "",
        "message": "成功"
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
# 1.2.4.2 失败
{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 201,
        "innerMessage": "",
        "message": "校验未通过",
        "checkResultEntity": {
            "checkItemEntityList": [
                {
                    "code": 2007,
                    "fieldName": "待办状态",
                    "fieldEName": "todoState",
                    "message": "参数不在规定的范围内[01, 02]",
                    "value": "03",
                    "isSuccess": false
                }
            ],
            "isSuccess": false,
            "target": "1efa90cef63ef13c93887260e3c39212"
        }
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 1.3删除待办接口

# 1.3.1接口地址

ip:port/taishanApi/todoApi/deleteTodoData
1

# 1.3.2传递参数

参数名称 参数说明 类型 数据格式/说明 必填 长度
appCode 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
appSecret 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
todoId 待办唯一值 varchar 待办唯一值 是 50
deletetime 删除时间 varchar yyyy-MM-dd HH:mm:ss 是

# 1.3.3返回参数

参数名称 类型 说明
code int 枚举服务器响应代码,成功为200
data object 接口返回的业务数据
└─ownCode int 业务返回编码,成功为200
└─innerMessage String 业务返回内部消息
└─message String 业务返回消息
└─checkResultEntity object 业务数据校验未通过返回的结果
message String 枚举所有的服务器响应成功或者失败的详细信息
success boolean 枚举所有的服务器响应状态

# 1.3.4返回实例

# 1.3.4.1 成功
{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 200,
        "innerMessage": "",
        "message": "成功"
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
# 1.3.4.2 失败
{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 201,
        "innerMessage": "",
        "message": "校验未通过",
        "checkResultEntity": {
            "checkItemEntityList": [
                {
                    "code": 2003,
                    "fieldName": "删除时间",
                    "fieldEName": "deletetime",
                    "message": "日期格式不符合规范:yyyy-MM-dd HH:mm:ss",
                    "value": "2023-06-25 16:57:2",
                    "isSuccess": false
                }
            ],
            "isSuccess": false,
            "target": "1efa90cef63ef13c93887260e3c39212"
        }
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 1.4查询待办接口

# 1.4.1接口地址

ip:port/taishanApi/todoApi/queryTodoData
1

# 1.4.2传递参数

参数名称 参数说明 类型 数据格式/说明 必填 长度
appCode 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
appSecret 认证服务时候的标识 varchar 在认证对接时候由认证方提供 是 200
todoId 待办唯一值 varchar 待办唯一值 是 50

# 1.4.3返回参数

参数名称 类型 说明
code int 枚举服务器响应代码,成功为200
data object 接口返回的业务数据
└─ownCode int 业务返回编码,成功为200
└─innerMessage String 业务返回内部消息
└─message String 业务返回消息
└─result object 业务数据校返回的结果
message String 枚举所有的服务器响应成功或者失败的详细信息
success boolean 枚举所有的服务器响应状态

# 1.4.4返回实例

# 1.4.4.1 成功
{
    "code": 200,
    "data": {
        "result": {
            "dealtime": "2023-06-25T16:57:22",
            "deptName": "发布部门",
            "releaseTime": "2023-06-25T16:57:22",
            "deletetime": "2023-06-25T16:57:21",
            "todoType": "待办类型",
            "undertakeName": "受理人",
            "appCode": "ts8247a39e1a5c4214847a16ef116d0225",
            "senderEname": "fsr",
            "title": "这是一条待办",
            "jumpUrl": "/ts/a/b?todoId=123",
            "todoState": "02",
            "senderName": "发送人",
            "messageType": "01",
            "undertakeEname": "slr",
            "appSecret": "08ad21671d4a87e0b7835c7d7c0244554880babd3b1902eb6f47ac2f0fdf3622af159990f311fe0a",
            "id": "e705101250c854b90656c6172818da44",
            "todoId": "1efa90cef63ef13c93887260e3c39212",
            "deptCode": "0000"
        },
        "ownCode": 200,
        "innerMessage": "",
        "message": "成功"
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 1.4.4.2 失败
{
    "code": 200,
    "data": {
        "result": null,
        "ownCode": 203,
        "innerMessage": "",
        "message": "未查询到该唯一值数据!",
        "todoId": "1efa90cef63ef13c93887260e3c392121"
    },
    "success": true,
    "message": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12