driver_id

string

Target Driver ID to edit.

Yes

Audit-User-Id

string

Pass a user_id here to create audit records with this user's details.

This can only be done if the authenticated API user has Roles / Apis checked for the permission Audit:UserIdOverride

No

Time-Zone

string

Driver events will be created in the specified timezone.

The timezone value can be given in several formats, none of which are case sensitive:

• As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'.

• As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'

• A leading zero can optionally be used for hours values less than 10;

Default value : UTC

No

driver_id

string

Pass the driver_id of the driver you are creating an event against.

Yes

driver_event_code_id

string

Pass a valid event_code_id for the type of event you want to create.

Yes

event_date

string

Pass the effective date of the driver event you are creating.

If no date is passed, the system date will be used.

If you want to set the date to be blank, you can pass a date of '0000-00-00'.

No

event_value

string

An event value can be passed. This will be ignored if there is an event_value_id or the event_value_id validation fails.

No

driver_event_value_id

string

Pass a driver_event_value_id if the event uses a configured list of event values.

Use the API getDriverEventValues to get a list of available values.

You do not need to pass a value if there is no configured list or you want to use the stored default value.

conditional

description

string

Pass an event description if the event does not have a stored list of descriptions.

This will be ignored if there is an event_description_id or the event_description_id validation fails.

Yes

driver_event_description_id

string

Pass the driver_event_description_id if there is a configured list of event descriptions.

Use the API getDriverEventDescriptions to get a list of available descriptions.

You do not need to pass a value if there is no configured list or you want to use the stored default description.

conditional

driver_event_action_id

string

Pass an action from the actions stored in [fm_driver_event_actions].

Use the API getDriverEventActions to get a list of available actions.

If no action is passed, the default value is 100000.

No

due_date

string

Pass the due date of the contract event you are creating if required.

No

completed_flag

string

If not passed, the default setting is used. This is stored as "Yes", "No".

No

attachment_id

string

Link a Driver Event to an Attachment ID.

No

user_id_edit

string

Last Edit By (User ID)

No

last_edit

string

Last Edit timestamp

No

status_flag

string

Event Status ('active','deleted')

No

Validation Message

Comments

200 OK

The request was successful and the driver event has been updated

401 - Unauthorized

You have not authenticated before running this API

403 - Forbidden

You do not have permissions for this request

422 - Unprocessable Entity

Validation failed - see error examples for specific issues