Expire specific document categories by specifying the login email address

POST [ expire-document-category-by-email/{documentCategoryId} ]

Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/expire-document-category-by-email/{documentCategoryId}
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/expire-document-category-by-email/{documentCategoryId}

Overview

This endpoint is used to expire a specific Document category for one or more Employees or Staffs by specifying their email addresses.

Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).

Permissions Required

The user should possess both below permissions:

API User
User is Staff

Please also refer to the Permissions Overview guide.

Query parameters

FIELD	TYPE	DESCRIPTION	Example	REQUIRED	DEFAULT	PATTERN
`documentCategoryId`	`integer`	Document Category ID	`163`	YES		`[0-9]`

Body properties/Payload

FIELD	TYPE	DESCRIPTION	REQUIRED
`email`	`array of strings`	Staff’s or Employee's’s email	No

Request Example

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/expire-document-category-by-email/189' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]' \
--form 'email[]="cfdemo-sn-test1@complyflow.com"' \
--form 'email[]="cfdemo-sn-test2@complyflow.com"'

Response Example

The API Request returns the information of the email that has a document that has been set to expire.

{
    "token": "",
    "data": {
        "statusCode": "200",
        "cfdemo-sn-11231324@complyflow.com": {
            "documentsExpired": [
                {
                    "staffId": 692,
                    "documentId": 266,
                    "documentName": null
                }
            ],
            "statusCode": "200"
        }
    }
}

Response Information

Status	Response
`success`	`statusCode` = `200`
`error`	`statusCode` != `200`