创建借阅接口V3

POST

/open/archiveBorrow/v3

请求参数

Header 参数

Authorization

string

可选

默认值:

Content-Type

string

可选

默认值:

application/json

Body 参数application/json

borrowType

string

必需

借阅类型 BorrowTypeEnum
PAPER_FILE_RECORD("纸质案卷")；
ELECTRONIC_DETAIL("电子单据")

openElectronicBorrowInsertReqDto

object (OpenElectronicBorrowInsertReqDto)

可选

电子借阅信息
与纸质借阅二选一

borrowerName

string

借阅人登录名

必需

allowDownload

boolean

可选

是否允许下载借阅内容

默认值:

public static final Boolean FALSE = new Boolean(false);

returnDeadline

string

截止归还日期

必需

remark

string

备注

可选

resourceReqDtoList

array[object (OpenResourceReqDto) {5}]

上传的文件信息

可选

electronicDetailDtoList

array[object (OpenElectronicDetailBorrowDto) {3}]

电子借阅明细

必需

openPaperBorrowInsertReqDto

object (OpenPaperBorrowInsertReqDto)

可选

纸质借阅信息
与电子借阅二选一

borrowerName

string

借阅人登录名

必需

fileForm

string

必需

档案介质 FileFormEnum
FILE_FORM

needReturn

boolean

可选

是否需要归还(false/true) 当“档案介质”等于“纸质档案-原件”时，该值为true

returnDeadline

string

可选

要求归还日期需要归还时，需填写

remark

string

备注

可选

borrowWay

enum<string>

借阅方式

可选

枚举值:

BORROW_OUTON_SITE_BORROW

默认值:

{desc: 外借}

resourceReqDtoList

array[object (OpenResourceReqDto) {5}]

上传的文件信息

可选

paperRecordDtoList

array[object (OpenPaperRecordBorrowDto) {1}]

纸质案卷借阅明细

必需

paperDetailDtoList

array[object (OpenPaperDetailBorrowDto) {2}]

纸质单据借阅明细

可选

示例

{
    "borrowType": "string",
    "openElectronicBorrowInsertReqDto": {
        "borrowerName": "string",
        "allowDownload": "public static final Boolean FALSE = new Boolean(false);",
        "returnDeadline": "string",
        "remark": "string",
        "resourceReqDtoList": [
            {
                "fileName": "string",
                "fileType": "string",
                "fileUrl": "string",
                "base64": "string",
                "md5Code": "string"
            }
        ],
        "electronicDetailDtoList": [
            {
                "customBillFlag": true,
                "billType": "string",
                "detailId": "string"
            }
        ]
    },
    "openPaperBorrowInsertReqDto": {
        "borrowerName": "string",
        "fileForm": "string",
        "needReturn": true,
        "returnDeadline": "string",
        "remark": "string",
        "borrowWay": "{desc: 外借}",
        "resourceReqDtoList": [
            {
                "fileName": "string",
                "fileType": "string",
                "fileUrl": "string",
                "base64": "string",
                "md5Code": "string"
            }
        ],
        "paperRecordDtoList": [
            {
                "detailId": "string"
            }
        ],
        "paperDetailDtoList": [
            {
                "detailId": "string",
                "billType": "string"
            }
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/open/archiveBorrow/v3' \
--header 'Authorization: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "borrowType": "string",
    "openElectronicBorrowInsertReqDto": {
        "borrowerName": "string",
        "allowDownload": "public static final Boolean FALSE = new Boolean(false);",
        "returnDeadline": "string",
        "remark": "string",
        "resourceReqDtoList": [
            {
                "fileName": "string",
                "fileType": "string",
                "fileUrl": "string",
                "base64": "string",
                "md5Code": "string"
            }
        ],
        "electronicDetailDtoList": [
            {
                "customBillFlag": true,
                "billType": "string",
                "detailId": "string"
            }
        ]
    },
    "openPaperBorrowInsertReqDto": {
        "borrowerName": "string",
        "fileForm": "string",
        "needReturn": true,
        "returnDeadline": "string",
        "remark": "string",
        "borrowWay": "{desc: 外借}",
        "resourceReqDtoList": [
            {
                "fileName": "string",
                "fileType": "string",
                "fileUrl": "string",
                "base64": "string",
                "md5Code": "string"
            }
        ],
        "paperRecordDtoList": [
            {
                "detailId": "string"
            }
        ],
        "paperDetailDtoList": [
            {
                "detailId": "string",
                "billType": "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:21

清除自定义单据板式文件

创建借阅接口