Get list of import documents

Updated date: 30/04/2023
Updated by: VNPT eContract's team

---

Purpose

A function to retrieve the list of document batches imported on the user's system.

• Request URL: /api/batch-imports
• HTTP method: GET
• Authorize: Bearer token
• Parameter: Not required, but additional options can be added below to filter or search the list of document batches.

Key	Type	Description
search	string	Search information by name of document batch
page	int	Page number (default is 1)
pagesize	int	Page size (default is 10 records)

Sample request

Query param:
    page: 1
    pageSize: 10
    search: BATCH IMPORT 001
Request: /api/batch-imports?page=1&pageSize=10&search=BATCH IMPORT 001

Sample response body

{
    "data": {
        "items": [
            {
                "id": 1231,
                "createdDate": "2022-12-02T15:04:28.7095771",
                "uploadedByUserId": 2320,
                "numberOfRecords": 1,
                "name": "BATCH IMPORT 001",
                "documents": [],
                "isSendable": false,
                "isCancelable": false
            }
        ],
        "totalCount": 1,
        "pageCount": 1,
        "page": 1,
        "pageSize": 10,
        "hasNextPage": true,
        "hasPreviousPage": false
    },
    "success": true,
    "code": 0,
    "messages": []
}