POST [ staff/{people_custom1}/complete-training ]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/complete-training
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/staff/{people_custom1}/complete-training
Overview
This endpoint adds a competency (online training) to a staff user in the current Organisation in the ComplyFlow system.
{people_custom1} can be renamed to any parameter for the account that makes sense, e.g. Internal Staff ID
Authentication instructions
Refer to the Authentication method for Authentication Methods (for Login and Logout).
Permissions Required
The user will require the permissions below:
API User
User is Staff
Users have View and Edit Staff Permission
The user has the same Organisation as the selected Staff
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | Example | REQUIRED | DEFAULT | PATTERN |
|
| Custom ID used to get staff detail data |
| YES |
|
|
The Custom ID needs to be configured on each Staff User’s profile - the ID needs to be unique
Body properties/Payload
FIELD | TYPE | DESCRIPTION | REQUIRED |
|
| Training Course ID | Yes |
|
| Date of training course result from (DD-MM-YYYY) | No |
|
| Date of training course valid to (DD-MM-YYYY) | Yes |
Request Example
curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/staff/shughi/complete-training' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]' \
--form 'id_training_course="103"' \
--form 'valid_to="03-09-2024"'
Response Example
The API Request returns the status of this API action.
{
"token": "",
"data": {
"success": true
}
}
Response Information
Status | Response |
|
|
|
|