Định dạng chung

Ngày cập nhật: 30 tháng 4, 2023
Người cập nhật: VNPT eContract's team

---

Trong tài liệu này chúng tôi sử dụng các quy ước sau nhằm giúp việc trình bày được rõ ràng và thuận tiện hơn trong việc nắm bắt nội dung:

• Tất cả param input/output theo format camelCase (Ví dụ: userName, cusCode, dayOfBirth…)
• Tất cả các response API đều sử dụng chung giao thức và được quy ước như sau:

Quy ước chung

Quy ước	Ý nghĩa	Ví dụ
Courier New	Đoạn code	{ "hasVerified": false, "fileName": "DocTemplate.docx" }
Bold	Nội dung cần nhấn mạnh	…yêu cầu phương thức POST
code	Tham số hoặc giá trị tham số, kết quả	HTTP Method: POST

Mẫu response mà hệ thống trả về bao gồm các thông tin như sau:

Key	Type	Description
data	object	Dữ liệu trả về là dạng json object hoặc json array hoặc string.
success	boolean	Trạng thái thành công của request true: thành công false: thất bại
code	int	Mã lỗi trả về từ hệ thống: 0: Mặc định 100: Cần xác nhận mã OTP 401: Chưa xác thực
message	array string	Mô tả thông tin từ hệ thống, hoặc lỗi chi tiết.

Mẫu response body

{
    "data": [
        {
            "id": 164,
            "name": "Công ty TNHH DH",
            "address": "42 Pasteur, P. Võ Thị Sáu, Quận 3, TP.Hồ Chí Minh",
            "taxCode": "0108212803-012",
            "createdDate": "2021-01-04T23:03:28.0149563",
            "status": {
                "value": 0,
                "description": "Active"
            }
        }
    ],
    "success": true,
    "code": 0,
    "messages": []
}