公文交换四川省人民政府版本

公文交换系统对外开放接口列表

简介:公文交换系统对外开放接口列表

HOST:59.225.203.24

联系人:

Version:1.0.0

接口路径:/v2/api-docs?group=b. 对外接口

公文相关

新发文

接口地址:/doc-exchange/oApi/docs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
	"attachments": [],
	"createdate": 0,
	"docIssuer": "",
	"docMark": "",
	"docPagesize": 0,
	"docSubject": "",
	"docType": "",
	"id": 0,
	"operatorOrgId": 0,
	"orgIdList": [],
	"originId": 0,
	"remark": "",
	"sendUnit": "",
	"urgentLevel": ""
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
requestDocOpenApiAddDTO requestDocOpenApiAddDTO body true RequestDocOpenApiNewAddDTO RequestDocOpenApiNewAddDTO
attachments 公文附件文件ID列表 false array integer
createdate 成文日期 false integer(int64)
docIssuer 签发人 false string
docMark 公文文号 false string
docPagesize 份数 false integer(int32)
docSubject 公文标题 false string
docType 公文种类 false string
id false integer(int64)
operatorOrgId 操作组织ID true integer(int64)
orgIdList 收文单位ID列表 false array integer
originId 公文正文文件唯一标识 false integer(int64)
remark 备注 false string
sendUnit 发文单位 false string
urgentLevel 紧急程度 false string
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponseDocIdDTO»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponseDocIdDTO ResponseDocIdDTO
docId 公文唯一标识 integer(int64)
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
{
	"code": 0,
	"data": {
		"docId": 0
	},
	"message": ""
}

新加送

接口地址:/doc-exchange/oApi/docs/append/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
5
{
	"comments": "",
	"operatorOrgId": 0,
	"orgIdList": []
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
requestDocHandleRecordDTO 公文处理请求体 body true RequestDocHandleOpenNewApiDTO RequestDocHandleOpenNewApiDTO
comments 备注 false string
operatorOrgId 操作组织ID true integer(int64)
orgIdList 单位唯一标识多个 true array integer
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«List«ResponseDocAppendDTO»»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 array ResponseDocAppendDTO
orgId 组织唯一标识 integer(int64)
orgName 组织名称 string
status 加送状态 string
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
{
	"code": 0,
	"data": [
		{
			"orgId": 0,
			"orgName": "",
			"status": ""
		}
	],
	"message": ""
}

新撤销

接口地址:/doc-exchange/oApi/docs/cancel/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
5
{
	"comments": "",
	"operatorOrgId": 0,
	"orgIdList": []
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
requestDocHandleRecordDTO 公文处理请求体 body true RequestDocHandleOpenNewApiDTO RequestDocHandleOpenNewApiDTO
comments 备注 false string
operatorOrgId 操作组织ID true integer(int64)
orgIdList 单位唯一标识多个 true array integer
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«JSONObject»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 object
message 响应信息描述 string

响应示例:

1
2
3
4
5
{
	"code": 0,
	"data": {},
	"message": ""
}

新公文交换详情

接口地址:/doc-exchange/oApi/docs/exchange/{docId}

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
receiveOrgId 组织ID query true integer(int64)
Authorization 用户token header false string
status 操作类型，不传则查询出所有收文单位 query false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponseDocExchangeDTO»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponseDocExchangeDTO ResponseDocExchangeDTO
denyNum 拒签收单位 integer(int32)
pageInfo 接收单位列表 ResponsePageInfoDTO«ResponseDocExchangeListDTO» ResponsePageInfoDTO«ResponseDocExchangeListDTO»
list 数据列表 false
comments 回执内容 false
contactInfoList 联系方式列表 false
contactInfo 联系电话 false
id 单位唯一标识 false
username 联系人 false
gmtModified 处理日期 false
operator 操作人 false
operatorContact 操作人联系方式 false
orgId 单位唯一标识 false
orgName 单位名称 false
status 状态 false
statusDesc 状态描述 false
pageNum 当前页数 false
pageSize 每页显示记录条数 false
pages 总页数 false
total 总记录数 false
sentNum 已发送单位 integer(int32)
signedNum 已签收单位 integer(int32)
toBeSignedNum 待签收单位 integer(int32)
message 响应信息描述 string

响应示例:

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
{
	"code": 0,
	"data": {
		"denyNum": 0,
		"pageInfo": {
			"list": [
				{
					"comments": "",
					"contactInfoList": [
						{
							"contactInfo": "",
							"id": 0,
							"username": ""
						}
					],
					"gmtModified": 0,
					"operator": "",
					"operatorContact": [],
					"orgId": 0,
					"orgName": "",
					"status": "",
					"statusDesc": ""
				}
			],
			"pageNum": 0,
			"pageSize": 0,
			"pages": 0,
			"total": 0
		},
		"sentNum": 0,
		"signedNum": 0,
		"toBeSignedNum": 0
	},
	"message": ""
}

新文件上传

接口地址:/doc-exchange/oApi/docs/fileupload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
operatorOrgId 组织ID query true integer(int64)
Authorization 用户token header false string
file 文件 formData false file

响应状态:

状态码 说明 schema
200 OK ResponseFileDTO
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
fileId 文件id integer(int64) integer(int64)
fileMd5 文件md5 string

响应示例:

1
2
3
4
{
	"fileId": 0,
	"fileMd5": ""
}

已发列表

接口地址:/doc-exchange/oApi/docs/page

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponsePageInfoDTO«ResponseDocSentDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponsePageInfoDTO«ResponseDocSentDTO» ResponsePageInfoDTO«ResponseDocSentDTO»
list 数据列表 array ResponseDocSentDTO
docMark 公文文号 false
docSubject 公文标题 false
gmtCreate false
gmtModified false
id false
sendOrgId 发文单位id false
sendOrgName 发文单位 false
sendUserName 发文人员 false
urgentLevel 紧急程度 false
pageNum 当前页数 integer(int32)
pageSize 每页显示记录条数 integer(int32)
pages 总页数 integer(int32)
total 总记录数 integer(int64)
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
	"code": 0,
	"data": {
		"list": [
			{
				"docMark": "",
				"docSubject": "",
				"gmtCreate": 0,
				"gmtModified": 0,
				"id": 0,
				"sendOrgId": 0,
				"sendOrgName": "",
				"sendUserName": "",
				"urgentLevel": ""
			}
		],
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"total": 0
	},
	"message": ""
}

已办列表

接口地址:/doc-exchange/oApi/docs/receive/page

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponsePageInfoDTO«ResponseDocReceiveDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponsePageInfoDTO«ResponseDocReceiveDTO» ResponsePageInfoDTO«ResponseDocReceiveDTO»
list 数据列表 array ResponseDocReceiveDTO
docFile 正文附件地址 false
docMark 公文文号 false
docSubject 公文标题 false
id false
receiveOrgId 收文单位 false
receiveTime 签收时间【已办公文】 false
sendOrgId 发文单位id false
sendOrgName 发文单位 false
sendUserName 发文人员 false
urgentLevel 紧急程度 false
pageNum 当前页数 integer(int32)
pageSize 每页显示记录条数 integer(int32)
pages 总页数 integer(int32)
total 总记录数 integer(int64)
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
	"code": 0,
	"data": {
		"list": [
			{
				"docFile": "",
				"docMark": "",
				"docSubject": "",
				"id": 0,
				"receiveOrgId": 0,
				"receiveTime": 0,
				"sendOrgId": 0,
				"sendOrgName": "",
				"sendUserName": "",
				"urgentLevel": ""
			}
		],
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"total": 0
	},
	"message": ""
}

新签收

接口地址:/doc-exchange/oApi/docs/receive/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
{
	"operatorOrgId": 0,
	"reason": ""
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
receiveReasonDTO receiveReasonDTO body true 签收备注 签收备注
operatorOrgId 操作组织ID true integer(int64)
reason 签收备注 false string
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«object»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 object
message 响应信息描述 string

响应示例:

1
2
3
4
5
{
	"code": 0,
	"data": {},
	"message": ""
}

新拒签

接口地址:/doc-exchange/oApi/docs/refuse/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
{
	"operatorOrgId": 0,
	"reason": ""
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
refuseReasonDTO refuseReasonDTO body true 拒签备注 拒签备注
operatorOrgId 操作组织ID true integer(int64)
reason 拒签备注 false string
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«object»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 object
message 响应信息描述 string

响应示例:

1
2
3
4
5
{
	"code": 0,
	"data": {},
	"message": ""
}

新待办公文

接口地址:/doc-exchange/oApi/docs/unReceive

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
orgIdList 查询单位ID列表 query true array integer
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
Authorization 用户token header false string
syncTime 同步截止时间（为空全量同步） query false integer(int64)

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponsePageInfoDTO«ResponseDocInfoNewDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponsePageInfoDTO«ResponseDocInfoNewDTO» ResponsePageInfoDTO«ResponseDocInfoNewDTO»
list 数据列表 array ResponseDocInfoNewDTO
arriveTime 到达时间【待办公文】 false
attachmentFiles 公文附件 false
fileId 公文文件唯一标识 false
fileMd5 文件md5 false
fileName 文件名称 false
fileSize 文件大小 false
orderNum 排序号 false
path 文件存放路径 false
createDate 成文日期 false
docMark 公文文号 false
docSubject 公文标题 false
docType 公文种类 false
id 公文唯一标识 false
mainFile 公文正文 false
fileId 公文文件唯一标识 false
fileMd5 文件md5 false
fileName 文件名称 false
fileSize 文件大小 false
orderNum 排序号 false
path 文件存放路径 false
receiveOrgId 收文单位 false
sendOrgId 发文单位id false
sendOrgName 发文单位 false
sendTime 发文时间 false
sendUserName 发文人员 false
urgentLevel 紧急程度 false
pageNum 当前页数 integer(int32)
pageSize 每页显示记录条数 integer(int32)
pages 总页数 integer(int32)
total 总记录数 integer(int64)
message 响应信息描述 string

响应示例:

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
41
42
43
44
{
	"code": 0,
	"data": {
		"list": [
			{
				"arriveTime": 0,
				"attachmentFiles": [
					{
						"fileId": 0,
						"fileMd5": "",
						"fileName": "",
						"fileSize": "",
						"orderNum": 0,
						"path": ""
					}
				],
				"createDate": 0,
				"docMark": "",
				"docSubject": "",
				"docType": "",
				"id": 0,
				"mainFile": {
					"fileId": 0,
					"fileMd5": "",
					"fileName": "",
					"fileSize": "",
					"orderNum": 0,
					"path": ""
				},
				"receiveOrgId": 0,
				"sendOrgId": 0,
				"sendOrgName": "",
				"sendTime": 0,
				"sendUserName": "",
				"urgentLevel": ""
			}
		],
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"total": 0
	},
	"message": ""
}

新详情

接口地址:/doc-exchange/oApi/docs/{docId}

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
receiveOrgId 组织ID query true integer(int64)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponseDocInfoDTO»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponseDocInfoDTO ResponseDocInfoDTO
attachmentFiles 公文附件 array 公文详情文件信息响应体
fileId 公文文件唯一标识 false
fileMd5 文件md5 false
fileName 文件名称 false
fileSize 文件大小 false
orderNum 排序号 false
path 文件存放路径 false
createdate 成文日期 integer(int64)
docIssuer 签发人 string
docMark 公文文号 string
docSubject 公文标题 string
docType 公文种类 string
id integer(int64)
mainFiles 公文正文 array 公文详情文件信息响应体
fileId 公文文件唯一标识 false
fileMd5 文件md5 false
fileName 文件名称 false
fileSize 文件大小 false
orderNum 排序号 false
path 文件存放路径 false
receiveOrgList 接收单位列表 array ResponseDocOrgDTO
comments 备注 false
handleTime 处理日期 false
id 接收单位唯一标识 false
name 接收单位名称 false
orderNum 排序号 false
status 状态 false
statusDesc 处理状态描述 false
remark 备注 string
sendUnit 发文单位 string
urgentLevel 紧急程度 string
message 响应信息描述 string

响应示例:

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
41
42
43
44
45
46
{
	"code": 0,
	"data": {
		"attachmentFiles": [
			{
				"fileId": 0,
				"fileMd5": "",
				"fileName": "",
				"fileSize": "",
				"orderNum": 0,
				"path": ""
			}
		],
		"createdate": 0,
		"docIssuer": "",
		"docMark": "",
		"docSubject": "",
		"docType": "",
		"id": 0,
		"mainFiles": [
			{
				"fileId": 0,
				"fileMd5": "",
				"fileName": "",
				"fileSize": "",
				"orderNum": 0,
				"path": ""
			}
		],
		"receiveOrgList": [
			{
				"comments": "",
				"handleTime": 0,
				"id": 0,
				"name": "",
				"orderNum": 0,
				"status": "",
				"statusDesc": ""
			}
		],
		"remark": "",
		"sendUnit": "",
		"urgentLevel": ""
	},
	"message": ""
}

发文

接口地址:/doc-exchange/openapi/docs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
	"attachments": [],
	"createdate": 0,
	"docIssuer": "",
	"docMark": "",
	"docPagesize": 0,
	"docSubject": "",
	"docType": "",
	"id": 0,
	"orgIdList": [],
	"originId": 0,
	"remark": "",
	"sendUnit": "",
	"urgentLevel": ""
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
requestDocOpenApiAddDTO requestDocOpenApiAddDTO body true RequestDocOpenApiAddDTO RequestDocOpenApiAddDTO
attachments 公文附件文件ID列表 false array integer
createdate 成文日期 false integer(int64)
docIssuer 签发人 false string
docMark 公文文号 false string
docPagesize 份数 false integer(int32)
docSubject 公文标题 false string
docType 公文种类 false string
id false integer(int64)
orgIdList 收文单位ID列表 false array integer
originId 公文正文文件唯一标识 false integer(int64)
remark 备注 false string
sendUnit 发文单位 false string
urgentLevel 紧急程度 false string
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponseDocIdDTO»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponseDocIdDTO ResponseDocIdDTO
docId 公文唯一标识 integer(int64)
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
{
	"code": 0,
	"data": {
		"docId": 0
	},
	"message": ""
}

加送

接口地址:/doc-exchange/openapi/docs/append/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
{
	"comments": "",
	"orgIdList": []
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
requestDocHandleRecordDTO 公文处理请求体 body true RequestDocHandleOpenApiDTO RequestDocHandleOpenApiDTO
comments 备注 false string
orgIdList 单位唯一标识多个 true array integer
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«JSONObject»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 object
message 响应信息描述 string

响应示例:

1
2
3
4
5
{
	"code": 0,
	"data": {},
	"message": ""
}

撤销

接口地址:/doc-exchange/openapi/docs/cancel/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
4
{
	"comments": "",
	"orgIdList": []
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
requestDocHandleRecordDTO 公文处理请求体 body true RequestDocHandleOpenApiDTO RequestDocHandleOpenApiDTO
comments 备注 false string
orgIdList 单位唯一标识多个 true array integer
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«JSONObject»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 object
message 响应信息描述 string

响应示例:

1
2
3
4
5
{
	"code": 0,
	"data": {},
	"message": ""
}

changeFileName

接口地址:/doc-exchange/openapi/docs/changeFileName

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
sec sec query true string
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

获取推送公文详情

接口地址:/doc-exchange/openapi/docs/details/{docId}

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId docId path true integer(int64)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

推送公文

接口地址:/doc-exchange/openapi/docs/docs

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

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
{
	"docAttachments": [
		{
			"fileMd5": "",
			"fileName": "",
			"fileSize": "",
			"fileUrl": ""
		}
	],
	"docCreatedate": 0,
	"docIssuer": "",
	"docMark": "",
	"docSubject": "",
	"docType": "",
	"mainDoc": {
		"fileMd5": "",
		"fileName": "",
		"fileSize": "",
		"fileUrl": ""
	},
	"receiveOrgIds": [],
	"remark": "",
	"sendUnit": "",
	"sendUnitId": 0,
	"sendUserId": 0,
	"sendUserName": "",
	"urgentLevel": ""
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
requestPushDocDTO requestPushDocDTO body true 推送公文dto 推送公文dto
docAttachments 附件信息 false array 分中心收文-请求体文件信息DTO
fileMd5 文件md5码 false string
fileName 文件名 true string
fileSize 文件大小 false string
fileUrl 文件下载地址 true string
docCreatedate 公文成文日志，不填默认now() false integer(int64)
docIssuer 签发人 false string
docMark 公文文号 true string
docSubject 公文标题 true string
docType 公文类型,可用值:01决议,02决定,03命令,04公报,05公告,06通告,07意见,08通知,09通报,10报告,11请示,12批复,13议案,14函,15纪要 false string
mainDoc 公文正文文件 true 分中心收文-请求体文件信息DTO 分中心收文-请求体文件信息DTO
fileMd5 文件md5码 false string
fileName 文件名 true string
fileSize 文件大小 false string
fileUrl 文件下载地址 true string
receiveOrgIds 收文单位列表 true array integer
remark 备注信息 false string
sendUnit 发文单位名称 false string
sendUnitId 发文单位id true integer(int64)
sendUserId 发文人员id false integer(int64)
sendUserName 发文人员名称 false string
urgentLevel 紧急程度,可用值:01 普通，02平急，03加急，04特急，05特提 false string
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

交换详情

接口地址:/doc-exchange/openapi/docs/exchange/{docId}/{status}

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
status 操作类型，不传则查询出所有收文单位 path true string
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

文件上传

接口地址:/doc-exchange/openapi/docs/fileupload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
Authorization 用户token header false string
file 文件 formData false file

响应状态:

状态码 说明 schema
200 OK ResponseFileDTO
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
fileId 文件id integer(int64) integer(int64)
fileMd5 文件md5 string

响应示例:

1
2
3
4
{
	"fileId": 0,
	"fileMd5": ""
}

获取组织变更记录

接口地址:/doc-exchange/openapi/docs/orgs/sync

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

已发列表

接口地址:/doc-exchange/openapi/docs/page

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponsePageInfoDTO«ResponseDocSentDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponsePageInfoDTO«ResponseDocSentDTO» ResponsePageInfoDTO«ResponseDocSentDTO»
list 数据列表 array ResponseDocSentDTO
docMark 公文文号 false
docSubject 公文标题 false
gmtCreate false
gmtModified false
id false
sendOrgId 发文单位id false
sendOrgName 发文单位 false
sendUserName 发文人员 false
urgentLevel 紧急程度 false
pageNum 当前页数 integer(int32)
pageSize 每页显示记录条数 integer(int32)
pages 总页数 integer(int32)
total 总记录数 integer(int64)
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
	"code": 0,
	"data": {
		"list": [
			{
				"docMark": "",
				"docSubject": "",
				"gmtCreate": 0,
				"gmtModified": 0,
				"id": 0,
				"sendOrgId": 0,
				"sendOrgName": "",
				"sendUserName": "",
				"urgentLevel": ""
			}
		],
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"total": 0
	},
	"message": ""
}

已办列表

接口地址:/doc-exchange/openapi/docs/receive/page

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponsePageInfoDTO«ResponseDocReceiveDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponsePageInfoDTO«ResponseDocReceiveDTO» ResponsePageInfoDTO«ResponseDocReceiveDTO»
list 数据列表 array ResponseDocReceiveDTO
docFile 正文附件地址 false
docMark 公文文号 false
docSubject 公文标题 false
id false
receiveOrgId 收文单位 false
receiveTime 签收时间【已办公文】 false
sendOrgId 发文单位id false
sendOrgName 发文单位 false
sendUserName 发文人员 false
urgentLevel 紧急程度 false
pageNum 当前页数 integer(int32)
pageSize 每页显示记录条数 integer(int32)
pages 总页数 integer(int32)
total 总记录数 integer(int64)
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
	"code": 0,
	"data": {
		"list": [
			{
				"docFile": "",
				"docMark": "",
				"docSubject": "",
				"id": 0,
				"receiveOrgId": 0,
				"receiveTime": 0,
				"sendOrgId": 0,
				"sendOrgName": "",
				"sendUserName": "",
				"urgentLevel": ""
			}
		],
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"total": 0
	},
	"message": ""
}

签收

接口地址:/doc-exchange/openapi/docs/receive/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
Authorization 用户token header false string
comments 备注 query false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«object»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 object
message 响应信息描述 string

响应示例:

1
2
3
4
5
{
	"code": 0,
	"data": {},
	"message": ""
}

反馈更新状态

接口地址:/doc-exchange/openapi/docs/record

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

1
2
3
{
	"recordIds": []
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
recordDTO recordDTO body true RequestOrgChangeRecordDTO RequestOrgChangeRecordDTO
recordIds 已处理记录ids true array integer
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

拒签

接口地址:/doc-exchange/openapi/docs/refuse/{docId}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
Authorization 用户token header false string
comments 备注 query false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«object»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 object
message 响应信息描述 string

响应示例:

1
2
3
4
5
{
	"code": 0,
	"data": {},
	"message": ""
}

交换统计

接口地址:/doc-exchange/openapi/docs/statistic/{docId}

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

待办列表

接口地址:/doc-exchange/openapi/docs/undo

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
pageNum 页码 query true integer(int32)
pageSize 每页数量 query true integer(int32)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponsePageInfoDTO«ResponseDocUndoDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponsePageInfoDTO«ResponseDocUndoDTO» ResponsePageInfoDTO«ResponseDocUndoDTO»
list 数据列表 array ResponseDocUndoDTO
arriveTime 到达时间【待办公文】 false
docCreateTime 发文时间【待办公文】 false
docFile 正文附件地址 false
docMark 公文文号 false
docSubject 公文标题 false
id false
receiveOrgId 收文单位id false
sendOrgId 发文单位id false
sendOrgName 发文单位 false
sendUserName 发文人员 false
urgentLevel 紧急程度 false
pageNum 当前页数 integer(int32)
pageSize 每页显示记录条数 integer(int32)
pages 总页数 integer(int32)
total 总记录数 integer(int64)
message 响应信息描述 string

响应示例:

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": 0,
	"data": {
		"list": [
			{
				"arriveTime": 0,
				"docCreateTime": 0,
				"docFile": "",
				"docMark": "",
				"docSubject": "",
				"id": 0,
				"receiveOrgId": 0,
				"sendOrgId": 0,
				"sendOrgName": "",
				"sendUserName": "",
				"urgentLevel": ""
			}
		],
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"total": 0
	},
	"message": ""
}

详情

接口地址:/doc-exchange/openapi/docs/{docId}

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
docId 公文唯一标识 path true integer(int64)
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponseDocInfoDTO»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponseDocInfoDTO ResponseDocInfoDTO
attachmentFiles 公文附件 array 公文详情文件信息响应体
fileId 公文文件唯一标识 false
fileMd5 文件md5 false
fileName 文件名称 false
fileSize 文件大小 false
orderNum 排序号 false
path 文件存放路径 false
createdate 成文日期 integer(int64)
docIssuer 签发人 string
docMark 公文文号 string
docSubject 公文标题 string
docType 公文种类 string
id integer(int64)
mainFiles 公文正文 array 公文详情文件信息响应体
fileId 公文文件唯一标识 false
fileMd5 文件md5 false
fileName 文件名称 false
fileSize 文件大小 false
orderNum 排序号 false
path 文件存放路径 false
receiveOrgList 接收单位列表 array ResponseDocOrgDTO
comments 备注 false
handleTime 处理日期 false
id 接收单位唯一标识 false
name 接收单位名称 false
orderNum 排序号 false
status 状态 false
statusDesc 处理状态描述 false
remark 备注 string
sendUnit 发文单位 string
urgentLevel 紧急程度 string
message 响应信息描述 string

响应示例:

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
41
42
43
44
45
46
{
	"code": 0,
	"data": {
		"attachmentFiles": [
			{
				"fileId": 0,
				"fileMd5": "",
				"fileName": "",
				"fileSize": "",
				"orderNum": 0,
				"path": ""
			}
		],
		"createdate": 0,
		"docIssuer": "",
		"docMark": "",
		"docSubject": "",
		"docType": "",
		"id": 0,
		"mainFiles": [
			{
				"fileId": 0,
				"fileMd5": "",
				"fileName": "",
				"fileSize": "",
				"orderNum": 0,
				"path": ""
			}
		],
		"receiveOrgList": [
			{
				"comments": "",
				"handleTime": 0,
				"id": 0,
				"name": "",
				"orderNum": 0,
				"status": "",
				"statusDesc": ""
			}
		],
		"remark": "",
		"sendUnit": "",
		"urgentLevel": ""
	},
	"message": ""
}

开发前必读

获取access_token

接口地址:/doc-exchange/oApi/gettoken

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:【注意】正常情况下access_token有效期为7200秒，有效期内重复获取返回相同结果，并自动续期。

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
Authorization 用户token header false string
appkey 应用的唯一标识key query false integer(int32)
appsecret 应用的密钥 query false integer(int64)

响应状态:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

获取access_token

接口地址:/doc-exchange/openapi/gettoken

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:【注意】正常情况下access_token有效期为7200秒，有效期内重复获取返回相同结果，并自动续期。

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
Authorization 用户token header false string
appkey 应用的唯一标识key query false integer(int32)
appsecret 应用的密钥 query false integer(int64)

响应状态:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

1

组织架构

定时获取单位列表

接口地址:/doc-exchange/oApi/orgs/syncOrg

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
operatorOrgId 操作单位id query true integer(int64)
Authorization 用户token header false string
syncTime 查询截止时间，不传为全部 query false integer(int64)

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«List«ResponseOpenApiOrgDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 array ResponseOpenApiOrgDTO
deleted 是否已删除 integer(int32)
id 单位唯一标识 integer(int64)
local 是否本分中心数据 integer(int32)
orderNum 单位排序号 integer(int32)
orgName 单位名称 string
orgType 单位类型 string
parentId 上级单位唯一标识 integer(int64)
visible 是否可见 integer(int32)
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
	"code": 0,
	"data": [
		{
			"deleted": 0,
			"id": 0,
			"local": 0,
			"orderNum": 0,
			"orgName": "",
			"orgType": "01：机构 02：单位 03：部门",
			"parentId": 0,
			"visible": "0可见，1不可见"
		}
	],
	"message": ""
}

获取单位列表

接口地址:/doc-exchange/openapi/orgs

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«List«ResponseOrgListApiDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 array ResponseOrgListApiDTO
areaParentId 上级单位唯一标识 integer(int64)
contactInfoList 联系方式列表 array ResponseOrgContactInfoDTO
contactInfo 联系电话 false
id 单位唯一标识 false
username 联系人 false
id 单位唯一标识 integer(int64)
local 是否本分中心数据 1本分中心数据 2 其他分中心数据 integer(int32)
orderNum 单位排序号 integer(int32)
orgCode 单位编码 string
orgName 单位名称 string
orgType 单位类型 string
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
	"code": 0,
	"data": [
		{
			"areaParentId": 0,
			"contactInfoList": [
				{
					"contactInfo": "",
					"id": 0,
					"username": ""
				}
			],
			"id": 0,
			"local": 0,
			"orderNum": 0,
			"orgCode": "",
			"orgName": "",
			"orgType": ""
		}
	],
	"message": ""
}

获取所在单位的群组信息

接口地址:/doc-exchange/openapi/orgs/group

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«List«ResponseGroupOpenApiDTO»»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 array ResponseGroupOpenApiDTO
group boolean
id integer(int64)
name string
orgList array ResponseGroupOrgOpenapiDTO
hasKey 是否有key false
id false
local 是否本地系统产生的数据 false
orderNum false
orgName false
orgType false
message 响应信息描述 string

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
	"code": 0,
	"data": [
		{
			"group": true,
			"id": 0,
			"name": "",
			"orgList": [
				{
					"hasKey": 0,
					"id": 0,
					"local": 0,
					"orderNum": 0,
					"orgName": "",
					"orgType": ""
				}
			]
		}
	],
	"message": ""
}

获取单位树

接口地址:/doc-exchange/openapi/orgs/tree

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
Authorization 用户token header false string

响应状态:

状态码 说明 schema
200 OK ResponseEntityDTO«ResponseOrgTreeOpenApiDTO»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 响应状态码 integer(int32) integer(int32)
data 响应业务数据 ResponseOrgTreeOpenApiDTO ResponseOrgTreeOpenApiDTO
childrenOrgs 下级单位集合 array ResponseOrgTreeOpenApiDTO
childrenOrgs 下级单位集合 false
contactInfoList 联系方式列表 false
contactInfo 联系电话 false
id 单位唯一标识 false
username 联系人 false
hasKey 是否有key false
id 单位唯一标识 false
local 是否本地系统产生的数据 false
orderNum 单位排序号 false
orgCode 单位编码 false
orgName 单位名称 false
orgType 单位类型 false
contactInfoList 联系方式列表 array ResponseOrgContactInfoDTO
contactInfo 联系电话 false
id 单位唯一标识 false
username 联系人 false
hasKey 是否有key integer(int32)
id 单位唯一标识 integer(int64)
local 是否本地系统产生的数据 integer(int32)
orderNum 单位排序号 integer(int32)
orgCode 单位编码 string
orgName 单位名称 string
orgType 单位类型 string
message 响应信息描述 string

响应示例:

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
41
{
	"code": 0,
	"data": {
		"childrenOrgs": [
			{
				"childrenOrgs": [
					{}
				],
				"contactInfoList": [
					{
						"contactInfo": "",
						"id": 0,
						"username": ""
					}
				],
				"hasKey": 0,
				"id": 0,
				"local": 0,
				"orderNum": 0,
				"orgCode": "",
				"orgName": "",
				"orgType": ""
			}
		],
		"contactInfoList": [
			{
				"contactInfo": "",
				"id": 0,
				"username": ""
			}
		],
		"hasKey": 0,
		"id": 0,
		"local": 0,
		"orderNum": 0,
		"orgCode": "",
		"orgName": "",
		"orgType": ""
	},
	"message": ""
}
铂恩 > 公文交换
#文件 #用户 #获取 #自动 #请求 #上传 #续期 #统计 #list
公文交换四川省人民政府版本
https://www.biuaxia.cn/2022/06/15/16/02/00.html
作者
biuaxia
发布于
2022年6月15日
许可协议