Driver object

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.

Driver methods

First available in 2014.1

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 user using the provided token and key, then returns a new Driver object
	vendorKey	string
NewDrivers	tokenValue	string	0 = successful 1000 = errors occurred	Authenticates the user using the provided token and key, then returns the specified number of new Driver objects
	vendorKey	string
	total	int
RetrieveDriver	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Authenticates the user using the provided token and key, returns all Drivers objects which meet the specified criteria
	vendorKey	string
	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 user using the provided token and key, saves the provided Driver objects and updates the database if requested, then returns the saved objects if the save was successful
	vendorKey	string
	drivers	List<Drivers>
	updateDB	bool

Method Name

Parameters

Driver.ReturnObject.ReturnCode

Description

Name

Data type (in C#)

NewDriver

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the user using the provided token and key, then returns a new Driver object

vendorKey

string

NewDrivers

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the user using the provided token and key, then returns the specified number of new Driver objects

vendorKey

string

total

int

RetrieveDriver

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the user using the provided token and key, returns all Drivers objects which meet the specified criteria

vendorKey

string

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 user using the provided token and key, saves the provided Driver objects and updates the database if requested, then returns the saved objects if the save was successful

vendorKey

string

drivers

List<Drivers>

updateDB

bool

Properties and column mapping

Use the properties and column mapping for the Driver object in SystemsLink for TMWSuite.

Driver.ReturnObject

Use the Driver.ReturnObject details for the Driver object in SystemsLink for TMWSuite.

DriverUpdateInfo object

Use the DriverUpdateInfo object for the Driver object in SystemsLink for TMWSuite.

Criteria object

Use the Criteria object for the Driver object in SystemsLink for TMWSuite.