CheckCall object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

Check calls allow you to record or look up contact with a driver, tractor, trailer, or carrier. You can also record check calls that are associated with orders. The system maintains a history of the geographic locations that were points on the resource’s route.

External methods

The Return Value for all methods in this table is CheckCall.ReturnObject.
Method Name Parameters City.ReturnObject.ReturnCode Description

Name

Data type (in C#)

NewCheckCall

tokenValue

string

0 = successful

1000 = errors occurred

Validates the token value and creates a new CheckCall object in memory

NewCheckCalls

tokenValue

string

0 = successful

1000 = errors occurred

Validates the token value and creates the specified number of new CheckCall objects in memory

total

int

SaveCheckCall

tokenValue

string

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

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

checkcalls

List<CheckCall>

updateDB

bool

DeleteCheckCall

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Validates the token value and deletes the CheckCall with the provided CheckCallNumber

checkCallNumber

int
The Return Value for all methods in this table is CheckCall.PagedReturnObject.
Method Name Parameters City.ReturnObject.ReturnCode Description

Name

Data type (in C#)

RetrieveCheckCall

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Validates the token value and returns all CheckCall objects in a paged format that meet the provided criteria

criteria

CheckCall.Criteria