CityService
CityService provides methods for working with city data, including lookups by city name or ID, removing city data, and searching for a city.
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.
| It is important that added cities exist and match the entries within your mileage and mapping software. Adding cities that do not exist in your mileage and mapping software can result in orders that cannot be invoiced or trips that cannot be paid. |
Endpoint Address: [SystemsLinkRootUrl]/CityService.svc
Methods
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
Delete |
cityId |
int |
void |
Delete a city. |
Get |
cityId |
int |
City |
Get a city. |
GetCities |
cityIds |
List<int> |
List<City> |
Get a list of cities. |
GetCitiesForIds |
cityIds |
List<int> |
List<City> |
Get a list of cities. |
GetCityByName |
cityStateCounty |
string |
City |
Get a city that matches the city, state, and county. |
GetCityByNameStateZip |
name |
string |
City |
Get a city that matches the city, state, and zip code. |
state |
string |
|||
zip |
string |
|||
GetClosestCity |
latitude |
decimal |
int |
Get the ID of the city closest to the given latitude and longitude coordinates. |
longitude |
decimal |
|||
NewItem |
City |
Add a new city. Caution: Cities must match the entries within your mileage and mapping software. Adding a city that does not exist in the mapping software may result in orders that cannot be invoiced or trips that cannot be paid. |
||
Save |
city |
City |
City |
Save a city. |
Search |
cityfilter |
FilterObjectOfCity |
PagedResultOfCity |
Search for a city. |
Properties and column mapping
| Columns in Database Column Name are from the city database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
CityId |
int |
cty_code |
int |
|
ControlData |
string |
Not mapped to database. |
||
County |
string |
cty_county |
char(3) |
|
CreatedBy |
string |
Not mapped to database. |
||
CreatedDateTime |
DateTime? |
cty_createdate |
datetime |
|
GmtDelta |
double? |
cty_GMTDelta |
float |
|
IsDst |
bool? |
cty_DSTApplies |
char(1) |
|
Latitude |
decimal? |
cty_latitude |
decimal(14,6) |
|
Longitude |
decimal? |
cty_longitude |
decimal(14,6) |
|
Name |
string |
cty_name |
varchar(18) |
|
NameStateCounty |
string |
cty_nmstct |
varchar(30) |
|
Region1 |
string |
cty_region1 |
varchar(6) |
|
Region2 |
string |
cty_region2 |
varchar(6) |
|
Region3 |
string |
cty_region3 |
varchar(6) |
|
Region4 |
string |
cty_region4 |
varchar(6) |
|
RuleData |
List <ConcurrencyFieldRule> |
Not mapped to database. |
||
State |
string |
cty_state |
varchar(6) |
|
TimeZoneMinutes |
int? |
cty_TZMins |
smallint |
|
UpdateDateTime |
DateTime? |
cty_updateddate |
datetime |
|
UpdatedBy |
string |
cty_updatedby |
varchar(20) |
|
Zip |
string |
cty_zip |
varchar(10) |
|