Send notification of document processing completion

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

---

Purpose

Send notification of completed document processing to the email/SMS of the creator or all users involved in the document processing workflow (Through the system's CompletedDocumentNotification configuration)

• Request URL: /api/documents/send-notify
• HTTP method: POST
• Authorize: Bearer token
• Parameter:

Key	Type	Description
documentId	string	[Required] Id of document

Sample request

Id of document needs to notified:
    id: d83812e9-1a93-4872-fce3-08dad8f7f8b6
Request: /api/documents/send-notify/d83812e9-1a93-4872-fce3-08dad8f7f8b6

Sample response body

{
    "data": {
        "id": "100b176b-772d-460a-1613-08db16499253",
        "createdDate": "2023-02-24T16:29:04.2855136",
        "lastModifiedDate": "2023-02-24T16:30:10.2043546",
        "completedDate": "2023-02-24T16:30:10.2043571",
        "no": "177667",
        "subject": "Create document via API",
        "hasVerified": false,
        "fileType": 0,
        "status": {
            "value": 4,
            "description": "Completed document"
        },
        "contractStatus": {
            "value": 0,
            "description": "Undefined"
        },
        "description": "Create sample document via API",
        "createdByUserId": 6199,
        "processRecipientCount": 1,
        "processInOrder": false,
        "isWaitToSignDraw": false,
        "isWaitToSignDigital": false,
        "isWaitToApprove": false,
        "isCancelable": false,
        "isDeleteable": false,
        "isRestoreable": false,
        "isEditable": false,
        "isShareable": false,
        "isAccessable": false,
        "isExpired": false,
        "canDownload": false,
        "processes": [
            {
                "id": "5c2fca11-bcae-4be5-bbf5-08db16499263",
                "createdDate": "2023-02-24T16:29:11.5035411",
                "comId": 2211,
                "isOrder": false,
                "orderNo": 1,
                "signatureText": "Trinh",
                "reason": "Approve this valid documents",
                "pageSign": 1,
                "position": "12,738,204,828",
                "fontSize": 12,
                "displayType": {
                    "value": 3,
                    "description": "Image only"
                },
                "signedMethod": {
                    "value": 2,
                    "description": "VNPT Smart CA"
                },
                "accessPermission": {
                    "value": 2,
                    "description": "Sign draw"
                },
                "status": {
                    "value": 3,
                    "description": "Signed"
                },
                "processedDate": "2023-02-24T16:30:10.0958881",
                "processedByUserId": 6199,
                "documentId": "100b176b-772d-460a-1613-08db16499253"
            },
            {
                "id": "c0dd8b4e-2df0-4b55-bbf6-08db16499263",
                "createdDate": "2023-02-24T16:29:11.5035898",
                "comId": 2211,
                "isOrder": false,
                "orderNo": 1,
                "pageSign": 0,
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 1,
                    "description": "View only"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 6202,
                "documentId": "100b176b-772d-460a-1613-08db16499253"
            }
        ],
        "histories": [],
        "attachments": [],
        "relatedDocuments": [],
        "messages": [],
        "downloadUrl": "{HOST}/Api/Download?token=Tu4rS...",
        "returnUrl": "/App/Document?Query.Search=Test0.7922255123526964&Query.Status=4"
    },
    "success": true,
    "code": 0,
    "messages": [
        "Send notification success"
    ]
}