City object
First available in 2014.2.
For External SystemsLink for TMWSuite use only.
The city master file consists of all city locations that may be recorded for a trip, or referenced in a company, driver, tractor, trailer, or carrier profile. City profiles are recorded in the City File Maintenance window.
External methods
| The Return Value for all methods is City.ReturnObject. |
| Method Name | Parameters | City.ReturnObject.ReturnCode | Description | |
|---|---|---|---|---|
Name |
Data type (in C#) |
|||
tokenValue |
string |
0 = successful 1000 = errors occurred |
Authenticates the token value and creates a new City object in memory |
|
tokenValue |
string |
0 = successful 1000 = errors occurred |
Authenticates the token value and creates the specified number of new City objects in memory |
|
total |
int |
|||
tokenValue |
string |
0 = successful 100 = no records found 1000 = errors occurred |
Authenticates the token value and returns all City objects that meet the provided criteria |
|
criteria |
||||
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 City objects, and updates the database if requested, then returns the saved objects if the save was successful |
|
cities |
List<City> |
|||
updateDB |
bool |
|||