Carrier object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

The carrier master file consists of profiles of all inside and outside carriers that transport loads for your company. A profile must exist for a carrier before you can dispatch it on a trip. Carrier profiles are recorded in the Carrier Profile window.

External methods

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

Name

Data type (in C#)

NewCarrier

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token and creates a new Carrier object in memory

NewCarriers

tokenValue

string

0 = successful

1000 = errors occurred

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

total

int

RetrieveCarrier

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

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

criteria

Carrier.Criteria

SaveCarrier

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 Carrier objects, and updates the database if requested, then returns the saved objects if the save was successful

carriers

List<Carrier>

updateDB

bool