Thông Tin Tài Liệu

1.1 Mục đích sử dụng :

Dùng để lấy thông tin của một tài liệu từ hệ thống xFile theo các thông số bên dưới

1.1. URI :

Name
Description

URI

{{gateway}}/v1/api/doc/getInfo?identifier={refCode}

Content-Type

application/json

Method

GET

1.2. Request :

1.2.1 Request Headers :

Name
Required
Description
Remarks

X-API-Key

Y

API Key AWS

Authorization

Y

[xFile cấp cho đối tác]

1.2.2 Request Params :

Name
Type
Required
Description
Remarks

identifier

String

Y

RefCode của tài liệu

1.2.3 Request Sample :

Request URI:

{{gateway}}/v1/api/doc/getInfo?identifier=0221dc12-0fb6-4980-a01c-fd8b93a65f0e

1.3. Response :

1.3.1 Response Body - JSON:

Name
Type
Description
Remarks

status

Long

Trạng thái kết quả api trả về

0 : Thành công

1 : Thất bại

data

Object

Kết quả api trả về

Thông tin của tài liệu

1.3.2 Response Sample:

Response Success data
{
    "status": 0,
    "data": {
        "fileName": "Marcos Granados 9051204.pdf",
        "mimeType": "application/pdf",
        "size": 58308.0,
        "id": 3071,
        "refCode": "f2db25af426772d26e4be5cd82a3e8867332ee300f8651dce3d64e888a2957d7db8a0af8d479845b2d2ae1eda4e1120b4c787a4ef7b95bb8373c91e7a888e419",
        "storeCode": "S3",
        "makerId": "[email protected]",
        "makerDate": "2022-11-14T04:08:28.687+00:00",
        "updateDate": "2022-11-14T04:08:28.690+00:00",
        "updateId": "[email protected]",
        "objId": null,
        "obj": null,
        "docTypeId": 1,
        "tenantCode": "DEMO",
        "props": {
            "customer_name": "Nguyen Van A"
        },
        "extProps": null,
        "docType": null,
        "recordStatus": "O",
        "authStat": "A",
        "modNo": 0,
        "permission": null
    }
}

Last updated