City object
First available in SystemsLink: 2014.2
Used by External SystemsLink for TMWSuite.
Methods
The Return Value for all methods is City.ReturnObject. |
Method Name | Parameters | City.ReturnObject.ReturnCode | Description | |
---|---|---|---|---|
Name |
Data type (in C#) |
|||
N/A |
0 = successful 1000 = errors occurred |
Creates a new City object in memory |
||
total |
int |
0 = successful 1000 = errors occurred |
Creates the specified number of new City objects in memory |
|
criteria |
0 = successful 100 = no records found 1000 = errors occurred |
Returns all City objects that meet the provided criteria |
||
cities |
List<City> |
0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented |
Saves the provided City objects and updates the database if requested, then returns the saved objects if the save was successful |
|
updateDB |
bool |
Properties and column mapping
To condense the information in this table, the Database Column Name uses the following abbreviations for database tables: c = city |
Property | Database Column | Modifiable | Comments | |||
---|---|---|---|---|---|---|
Name |
Data Type (in C#) |
Name |
Data Type |
|||
1 |
ALKCity |
string |
c.alk_city |
varchar(40) |
Insert/Update |
|
2 |
ALKCounty |
string |
c.alk_county |
varchar(15) |
Insert/Update |
|
3 |
ALKCountyName |
string |
c.alk_county_name |
varchar(50) |
Insert/Update |
|
4 |
ALKState |
string |
c.alk_state |
varchar(2) |
Insert/Update |
|
5 |
AreaCode |
string |
c.cty_areacode |
varchar(6) |
Insert/Update |
|
6 |
Code |
int |
c.cty_code |
int |
Read only |
Private key |
7 |
Country |
string |
c.cty_country |
char(4) |
Insert/Update |
|
8 |
County |
string |
c.cty_county |
char(3) |
Insert/Update |
|
9 |
CountyName |
string |
c.county_name |
varchar(50) |
Insert/Update |
|
10 |
DataSourceID |
string |
N/A |
Not mapped |
||
11 |
DaylightSavings |
bool |
c.cty_DSTApplies |
char(1) |
Insert/Update |
|
12 |
FuelCreatedFlag |
short |
c.cty_fuelcreate |
smallint |
Insert/Update |
|
13 |
IsDirty |
bool |
N/A |
Not mapped or used in service |
||
14 |
IsNew |
bool |
N/A |
Not mapped, set to false during save to update |
||
15 |
IsValid |
bool |
N/A |
Not mapped or used in service |
||
16 |
Latitude |
decimal |
c.cty_latitude |
Decimal(12,4) |
Insert/Update |
|
17 |
Longitude |
decimal |
c.cty_longitude |
Decimal(12,4) |
Insert/Update |
|
18 |
Name |
string |
c.cty_name |
varchar(18) |
Insert/Update |
|
19 |
NameStateCountyDisplay |
string |
c.cty_nmstct |
varchar(30) |
Read only |
|
20 |
RandCity |
string |
c.rand_city |
varchar(25) |
Insert/Update |
|
21 |
RandCounty |
string |
c.rand_county |
varchar(2) |
Insert/Update |
|
22 |
RandCountyName |
string |
c.rand_county_name |
varchar(50) |
Insert/Update |
|
23 |
RandState |
string |
c.rand_state |
varchar(2) |
Insert/Update |
|
24 |
Region1 |
string |
c.cty_region1 |
varchar(6) |
Insert/Update |
|
25 |
Region2 |
string |
c.cty_region2 |
varchar(6) |
Insert/Update |
|
26 |
Region3 |
string |
c.cty_region3 |
varchar(6) |
Insert/Update |
|
27 |
Region4 |
string |
c.cty_region4 |
varchar(6) |
Insert/Update |
|
28 |
SPLC |
int |
c.cty_splc |
int |
Insert/Update |
|
29 |
State |
string |
c.cty_state |
varchar(6) |
Insert/Update |
|
30 |
TimeZoneDelta |
double |
c.GMTDelta |
float |
Insert/Update |
|
31 |
UpdateableProperties |
N/A |
Not mapped |
|||
32 |
Zip |
string |
c.cty_zip |
varchar(10) |
Insert/Update |
City.ReturnObject
Property Name | Data Type (in C#) | Comments | |
---|---|---|---|
1 |
ErrorMessages |
List <string> |
|
2 |
ErrorObjectIndexList |
List <int> |
|
3 |
Exceptions |
List <Exception> |
|
4 |
ReferenceObjects |
List<City> |
|
5 |
ReturnCode |
int |
|
6 |
TraceMessages |
List <string> |
|
7 |
WarningMessages |
List <string> |
CityUpdateInfo object
|
Property Name | |
---|---|
1 |
ALKCity |
2 |
ALKCounty |
3 |
ALKCountyName |
4 |
ALKState |
5 |
AreaCode |
6 |
Country |
7 |
County |
8 |
CountyName |
9 |
DaylightSavings |
10 |
FuelCreatedFlag |
11 |
Latitude |
12 |
Longitude |
13 |
Name |
14 |
RandCity |
15 |
RandCounty |
16 |
RandCountyName |
17 |
RandState |
18 |
Region1 |
19 |
Region2 |
20 |
Region3 |
21 |
Region4 |
22 |
SPLC |
23 |
State |
24 |
TimeZoneDelta |
25 |
Zip |
Criteria object
To condense the information in table, the Database Column uses the following abbreviations for database tables: c = city |
Name | Database Column | Data Type (in C#) | Comments | |
---|---|---|---|---|
1 |
ALKCity |
c.alk_city |
string |
|
2 |
ALKCounty |
c.alk_county |
string |
|
3 |
ALKCountyName |
c.alk_county_name |
string |
|
4 |
ALKState |
c.alk_state |
string |
|
5 |
AreaCode |
c.cty_areacode |
string |
|
6 |
Code |
c.cty_code |
int? |
|
7 |
Country |
c.cty_country |
string |
|
8 |
County |
c.cty_county |
string |
|
9 |
CountyName |
c.county_name |
string |
|
10 |
DaylightSavings |
c.cty_DSTApplies |
string |
|
11 |
FuelCreatedFlag |
c.cty_fuelcreate |
short? |
|
12 |
LatitudeEnd |
c.cty_latitude |
decimal? |
Creates a range to form a limit for latitude |
13 |
LatitudeStart |
c.cty_latitude |
decimal? |
|
14 |
LongitudeEnd |
c.cty_longitude |
decimal? |
Creates a range to form a limit for longitude queries |
15 |
LongitudeStart |
c.cty_longitude |
decimal? |
|
16 |
Name |
c.cty_name |
string |
|
17 |
NameStateCountyDisplay |
c.cty_nmstct |
string |
|
18 |
RandCity |
c.rand_city |
string |
|
19 |
RandCounty |
c.rand_county |
string |
|
20 |
RandCountyName |
c.rand_county_name |
string |
|
21 |
RandState |
c.rand_state |
string |
|
22 |
Region1 |
c.cty_region1 |
string |
|
23 |
Region2 |
c.cty_region2 |
string |
|
24 |
Region3 |
c.cty_region3 |
string |
|
25 |
Region4 |
c.cty_region4 |
string |
|
26 |
SPLC |
c.cty_splc |
int? |
|
27 |
State |
c.cty_state |
string |
|
28 |
TimeZoneDelta |
c.GMTDelta |
double? |
|
29 |
Zip |
c.cty_zip |
string |