# 待办拉取规范

拉取方式接口由业务系统提供

# 心跳检测接口

该接口主要用来监测平台到业务系统是否网络可达,用来保证待办中心的可用性。

# 请求路径:

/heart/healthy

# 请求方法:

GET

# 返回信息:

true
1

# 示例

  • 请求范例:

    GET /heart/healthy
    Host: server.example.com
    
    1
    2
  • 响应范例:

    true
    
    1

# 数量数据接口

该接口主要提供代办相关业务数据统计通能,在代办中心业务中显示。

# 请求路径:

/count

# 请求方法:

GET

# 请求参数:

参数 是否必须 说明
systemCode 系统编码
userId 用户Id(hr系统)

# 返回信息:

名称 类型 字段名
count int 总数
todayCount int 今日新增数量
weekCount int 一周新增数量(自然周)
monthCount int 一月新增数量(自然月)
preProcessCount int 待办总数
alreadyProcessCount int 已办总数
preReadCount int 待阅总数
alreadyReadCount int 已阅总数
systemName String 系统名称
systemCode String 系统编码
status int 返回状态(数据只处理200状态)

示例

  • 请求范例:
GET /count?systemCode=CWXT
Host: server.example.com
1
2
  • 响应范例:
{
    "data": {
		"count": 200,
		"todayCount": 20,
        "weekCount": 20,
        "monthCount": 40,
        "preProcessCount": 60,
		"preReadCount": 40,
		"alreadyProcessCount": 30,
		"alreadyReadCount": 70,
		"systemName": "合同系统",
		"systemCode": "HTXT"
	},
    "status": 200
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 列表数据接口

该接口为代办中心核心接口,提供具体代办中心各类列表信息。

注:业务系统待办需要遵守按照先紧急程度后时间的排序规则

pdatetime创建时间,查询待办、待阅以pdatetime倒叙排列

auditTime处理时间,查询已办、已阅以auditTime倒叙排列

# 请求路径:

/preHandle

# 请求方法:

GET

# 请求参数:

参数 是否必须 说明
pageNum 当前页
pageSize 条数/页
ptype 数据类型DS:待办、DY:待阅、YS:已办、YY:已阅
ptitle 标题(支持模糊搜索)
systemCode 系统编码
userId 用户Id(hr系统)

# 返回信息:

名称 类型 字段名
total int 总数
size int 条数/页
current int 当前页
pages int 多少页
systemCode String 待办对应的应用系统编号
systemName String 待办对应的应用系统名称
bizCode String 待办业务类型编码
ptype String 待办类别
pid String 待办ID
ptitle String 待办标题
pdesc String 待办描述
pdatetime Date 待办发起时间 (接收时间,指当前登录用户接收待办、待阅的时间,按该时间倒序排列;比如:当前登录用户为叶英杰,该时间为叶英杰接收到待办、待阅的时间;)
pcreator String 发起人姓名
pcreatorId String 发起人ID
ptoUserCode String 办理人CODE
ptoUserId String 办理人ID
ptoUserName String 办理人姓名
pendDatetime Date 截至时间
preDatetime Date 催办时间
pcUrl String PC端URL
mobileUrl String MOBIL端URL
auditNode String 处理节点
auditResult String 处理结果
auditView String 处理意见 (指当前登录用户处理待办、待阅的操作时所填写的意见;比如:当前登录用户为叶英杰,在点击“办毕”前填写的处理意见;)
auditTime Date 处理时间 (指当前登录用户处理待办、待阅的操作时间,并按该时间倒序排列;比如:当前登录用户为叶英杰,点击“办毕”按钮的操作时间;)
emergencyType String 紧急程度 1特急、2加急、3紧急、4一般
readed boolean 是否已读 true表示已读,false、空表示未读
status int 返回状态(数据只处理200状态)

# 示例

  • 请求范例:
GET /preHandle?pageNum=1&pageSize=10&systemCode=KJXT&ptype=DS&ptitle=国际
Host: server.example.com
1
2
  • 响应范例:
{
    "data": {
        "records": [
			{
				"systemId": null,
				"systemCode": "HTXT",
				"systemName": "合同系统",
				"bizCode": null,
				"pid": "1",
				"ptoUserCode": null,
				"ptoUserId": "2019",
				"ptoUserName": "冯导",
				"pendDatetime": null,
				"preDatetime": null,
				"pcUrl": "http://www.baidu.com",
				"mobileUrl": null,
				"auditNode": null,
				"auditResult": null,
				"auditView": null,
				"auditTime": null,
				"ptype": "DY",
				"ptitle": "待办--国际工程公司召开",
				"pdesc": "desc:1",
				"pcreator": "张三",
				"pcreatorId": null,
				"pdatetime": 1635147386322,
				"auditTime": 1635147386322,
				"emergencyType": 1,
                "readed":true
			}
		],
		"total": 20,
		"size": 1,
		"current": 1,
		"orders": [],
		"searchCount": true,
		"pages": 20
    },
    "status": 200
}
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
31
32
33
34
35
36
37
38
39
40