Driver object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

The driver master file consists of profiles of all drivers used by your company. This includes company drivers, owner/operators who drive, and drivers who work for inside carriers. A profile must exist for a driver before you can dispatch him on a trip. Driver profiles are recorded in the Driver Profile window.

External methods

The Return Value for all methods is Driver.ReturnObject.
Method Name Parameters Driver.ReturnObject.ReturnCode Description

Name

Data type (in C#)

NewDriver

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates a new Driver object in memory

NewDrivers

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates the specified number of new Driver objects in memory

total

int

RetrieveDriver

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the token value and returns all Driver objects that meet the provided criteria

criteria

Driver.Criteria

SaveDriver

tokenValue

string

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Authenticates the token value, saves the provided Driver objects, and updates the database if requested, then returns the saved objects if the save was successful

drivers

List<Driver>

updateDB

bool