创建借阅接口

POST

/open/archiveBorrow

请求参数

Header 参数

Authorization

string

可选

默认值:

Content-Type

string

可选

默认值:

application/json

Body 参数application/json

borrowerName

string

借阅人名

必需

reason

string

借阅事由/备注

必需

returnDeadline

string

可选

截止归还日期
needReturn = true时，需填写;
needReturn = false时，无需填写;

archiveBorrowDetailList

array[object (OpenArchiveBorrowDetailDto) {9}]

可选

电子借阅明细列表
与纸质借阅二选一

borrowPage

boolean

可选

是否借阅纸质文档默认false

period

string

会计期间

可选

fileType

string

可选

档案类型，枚举：FileTypeEnum
FILE_TYPE

fileResultId

string

可选

关联归档记录ID 未归档的凭证进行借阅时，该字段为空
FILE_RESULT_ID

detailType

string

可选

内容类型，枚举：ArchiveBorrowDetailTypeEnum
DETAIL_TYPE

detailId

string

可选

内容id
DETAIL_ID

detailName

string

可选

内容名称
DETAIL_NAME

fileRecordId

string

可选

关联案卷的ID
FILE_RECORD_ID

errMsg

string

记录返回的失败原因

可选

fileForm

string

可选

档案介质 FileFormEnum
不填默认借阅电子档案
ELECTRONIC("电子档案")；
PAPER("纸质档案-原件")；
PAPER_COPY("纸质档案-复印件")
(4.5后新增)

默认值:

FileFormEnum.ELECTRONIC.name()

needReturn

boolean

可选

是否需要归还(false/true)
电子借阅为true；当“档案介质”等于“纸质档案-原件”时，该值为true
(4.5后新增)

默认值:

true

resourceReqDtoList

array[object (OpenResourceReqDto) {5}]

可选

上传的文件信息
(4.5后新增)

fileName

string

上传的文件名

必需

fileType

string

上传的文件类型

必需

fileUrl

string

可选

上传的文件url 和 base64 二选一

base64

string

可选

上传文件base64数据和 fileUrl 二选一

md5Code

string

可选

上传文件的md5校验码需要校验时传入

paperRecordDtoList

array[object (OpenPaperRecordBorrowDto) {1}]

可选

纸质案卷借阅明细
与电子借阅二选一
(4.5后新增)

detailId

string

必需

借阅类型为纸质案卷，案卷数据库ID

示例

{
    "borrowerName": "string",
    "reason": "string",
    "returnDeadline": "string",
    "archiveBorrowDetailList": [
        {
            "borrowPage": true,
            "period": "string",
            "fileType": "string",
            "fileResultId": "string",
            "detailType": "string",
            "detailId": "string",
            "detailName": "string",
            "fileRecordId": "string",
            "errMsg": "string"
        }
    ],
    "fileForm": "FileFormEnum.ELECTRONIC.name()",
    "needReturn": "true",
    "resourceReqDtoList": [
        {
            "fileName": "string",
            "fileType": "string",
            "fileUrl": "string",
            "base64": "string",
            "md5Code": "string"
        }
    ],
    "paperRecordDtoList": [
        {
            "detailId": "string"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/open/archiveBorrow' \
--header 'Authorization: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "borrowerName": "string",
    "reason": "string",
    "returnDeadline": "string",
    "archiveBorrowDetailList": [
        {
            "borrowPage": true,
            "period": "string",
            "fileType": "string",
            "fileResultId": "string",
            "detailType": "string",
            "detailId": "string",
            "detailName": "string",
            "fileRecordId": "string",
            "errMsg": "string"
        }
    ],
    "fileForm": "FileFormEnum.ELECTRONIC.name()",
    "needReturn": "true",
    "resourceReqDtoList": [
        {
            "fileName": "string",
            "fileType": "string",
            "fileUrl": "string",
            "base64": "string",
            "md5Code": "string"
        }
    ],
    "paperRecordDtoList": [
        {
            "detailId": "string"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

com.maycur.cm.dto.ResultDto<com.maycur.cm.open.dto.borrow.OpenArchiveBorrowInsertRespDto>

code

integer

结果代码

可选

message

string

结果信息

可选

errMsg

string

错误信息

可选

data

object (OpenArchiveBorrowInsertRespDto)

结果数据

可选

success

boolean

可选

msg

string

可选

errData

object (Map«String»)

可选

java.util.Map<java.lang.Integer,java.lang.String>

timestamp

string

时间戳

可选

示例

{
  "code": 0,
  "message": "",
  "errMsg": "",
  "data": {
    "success": false,
    "msg": "",
    "errData": {
      "0": ""
    }
  },
  "timestamp": ""
}

修改于 2023-09-06 06:00:02

创建借阅接口V3

借阅归还接口