Employee API

A question of type employee_api allows the user to select an employee from a list of employees.

The list of employees is fetched from FleetControl and the local database.

{
    "id": 0,
    "required": true,
    "type": "employee_api",
    "key": "employee_api",
    "label": "employee_api",
    "answers": [
        {
            "id": 0,
            "nextQuestionId": 1,
            "options": {
                "saveId": true,
                "excludedDriverIDs": [
                    "27933"
                ]
            }
        }
    ]
}
    

Answer Options

This chapter describes the option possibilities for an answer.

Name	Type	Description	Required	Default
saveId	bool	If set to true, the internal database ID of the entity is saved	false	false
defaultValue	string	The default value The saved answer will override this value.	false	If `saveId` is set to true, this is the database ID of the selected employee. If set to false, this is the name of the selected employee.
excludedDriversIDS	string[]	An array of string values that represent the employee ID's that are excluded from the list of employees.	false	[ ]

Examples

Employee API example

An example image for question_employee_api

                        {
                            "id": 0,
                            "required": true,
                            "type": "employee_api",
                            "key": "employee_api",
                            "label": "employee_api",
                            "answers": [
                                {
                                    "id": 0,
                                    "nextQuestionId": 1,
                                    "options": {
                                        "saveId": true,
                                        "excludedDriverIDs": [
                                            "27933"
                                        ]
                                    }
                                }
                            ]
                        }
                    

Last modified: 04 June 2025