Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Scheduling

Get Drivers

Retrieves a list of drivers based on various query parameters, such as ActorId, DriverStatusId, and multiple search options (e.g., by DriverId, UserId, Fullname, etc.).

get/v1/Scheduling/drivers

Query parameters

ActorIdinteger

The unique identifier of the actor associated with the drivers.

DriverStatusIdinteger

The status identifier of the drivers to filter the results.

Searchstring

A search string used to find drivers based on various fields.

SearchByDriverIdboolean

Indicates whether to search by DriverId.

SearchByUserIdboolean

Indicates whether to search by UserId.

SearchByFullnameboolean

Indicates whether to search by the driver's fullname.

SearchByMobileboolean

Indicates whether to search by the driver's mobile number.

SearchByEmailboolean

Indicates whether to search by the driver's email address.

SearchByIdNumberboolean

Indicates whether to search by the driver's identification number.

SearchByDriverLicenseboolean

Indicates whether to search by the driver's license number.

Response

A list of drivers that match the specified criteria.

Idstring uuid

The unique identifier of the driver.

DistributorIdinteger

The unique identifier of the distributor associated with the driver.

OperatorIdinteger

The unique identifier of the operator associated with the driver.

OperatorNamestring nullable

The name of the operator associated with the driver.

UserIdinteger

The unique identifier of the user associated with the driver.

FullNamestring nullable

The full name of the driver.

Mobilestring nullable

The mobile phone number of the driver.

Emailstring nullable

The email address of the driver.

DriverLicensestring nullable

The driver's license number of the driver.

IdNumberstring nullable

The identification number of the driver.

Imgstring nullable

The URL to the driver's image.

DriverStatusIdinteger nullable

The status identifier of the driver, indicating their current status.

StartDatestring nullable

The date when the driver started working.

Skillsinteger[] nullable

A list of skill identifiers associated with the driver.

WorkingHoursstring nullable

The working hours of the driver.

CreatedByinteger

The identifier of the user who created the driver entry.

CreatedDtstring date-time

The date and time when the driver entry was created.

UpdatedByinteger nullable

The identifier of the user who last updated the driver entry.

UpdatedDtstring date-time nullable

The date and time when the driver entry was last updated.