latestSwagger 2.02026-08-084062117.9 KB

78fc4b609513

Drivers

UPDATE a specific driver

Post a map of key value pairs for fields with the new value. A value of null is accepted (where marked as nullable) and will clear that field. Cleared fields will not be shown in the response, as null fields are stripped by default. If a field is not present in the map it will not be altered. Fields not marked as nullable can be left out of the map all together so as not to be changed

post/v1/drivers/{uuid}

Path parameters

uuidstring uuid required

Request body

startDatestring date nullable
organizationUuidstring uuid
gender'MALE' | 'FEMALE' nullable
firstNamestring
middleNamestring nullable
lastNamestring
emailWorkstring nullable

A valid email address.

emailPrivatestring nullable

A valid email address.

notificationChannel'EMAIL' | 'SMS' nullable
addressstring nullable
zipCodestring nullable
citystring nullable
countrystring nullable

ISO 3166-1 Alpha-2 country code

languagestring nullable

ISO 639-1 Language Code

nationalitystring nullable

ISO 3166-1 Alpha-2 country code

placeOfBirthstring nullable
birthDatestring date nullable
internalIdstring nullable
costCenterstring nullable
subCompanystring nullable
departmentstring nullable
locationstring nullable
commentstring nullable
distanceToWorkplacenumber nullable
employeePaymentnumber nullable

Response

Successful operation.

uuidstring uuid
state'ACTIVE' | 'INACTIVE' | 'LEAVE'
startDatestring date
gender'MALE' | 'FEMALE'
firstNamestring
middleNamestring
lastNamestring
emailWorkstring

A valid email address.

emailWorkType'MANUAL' | 'AUTOMATIC'
emailPrivatestring

A valid email address.

notificationChannel'EMAIL' | 'SMS'
addressstring
zipCodestring
citystring
countrystring

ISO 3166-1 Alpha-2 country code

languagestring

ISO 639-1 Language Code

nationalitystring

ISO 3166-1 Alpha-2 country code

placeOfBirthstring
birthDatestring date
internalIdstring
costCenterstring
subCompanystring
departmentstring
locationstring
commentstring
distanceToWorkplacenumber
employeePaymentnumber
eligibleForDriverBriefingsboolean
eligibleForDriverLicenseChecksboolean
managementType'MANUAL' | 'AUTOMATIC'
organizationUuidstring uuid