Expiration object

Expiration properties and column mapping

To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:

e = expiration
Property Database Column

Name

Data Type (in C#)

Name

Data Type

Modifiable

Comments

1

AssetID

string

e.exp_id

varchar(13)

Insert/Update

2

AssetType

string

e.exp_idtype

char(3)

Insert/Update

3

AutoComplete

bool

Read-only

Calculated from AssetType

4

CityCode

int

e.exp_city

Insert/Update

5

CityNameStateCounty

string

Read-only

Calculated from CityCode

6

Completed

bool

e.exp_completed

char(1)

Insert/Update

7

CompletionDate

DateTime

e.exp_compldate

datetime

Insert/Update

8

CreatedOn

DateTime

e.exp_creatdate

datetime

Insert/Update

9

CreateMove

bool

Read-only

Calculated from AssetType

10

DataSourceID

string

Read-only

Not mapped

11

Description

string

e.exp_description

varchar(100)

Insert/Update

12

ExpirationCode

string

e.exp_code

varchar(6)

Insert/Update

13

ExpirationStartDate

DateTime

e.exp_expirationdate

datetime

Insert/Update

14

ID

int

e.exp_key

int

Read-only

Key

15

IsDirty

bool

N/A

Not mapped or used in service

16

IsNew

bool

N/A

Not mapped, set to false during save to update

17

IsValid

bool

N/A

Not mapped or used in service

18

MilesToExpiration

int

e.exp_milestoexp

int

Insert/Update

19

MoveNumber

int

e.mov_number

int

Insert/Update

20

Priority

string

e.exp_priority

varchar(6)

Insert/Update

21

PriorityType

ExpirationPriorityTypeEnum

Read-only

Calculated from Priority

22

RouteTo

string

e.exp_routeto

varchar(12)

Insert/Update

23

UpdateableProperties

ExpirationUpdateInfo

N/A

Not mapped

24

UpdatedBy

string

e.exp_updateby

varchar(20)

Insert/Update

25

UpdatedOn

DateTime

e.exp_updateon

datetime

Insert/Update

Expiration methods

The Return Value for all methods is Expiration.ReturnObject.

Internal

Parameters

Method Name

Name

Data type (in C#)

Expiration.ReturnObject.ReturnCode

Description

NewExpiration

assetType

AssetTypeEnum

0 = successful

1000 = errors occurred

Creates a new Expiration object with the specified asset type and ID in memory

assetID

string

NewExpirations

assetType

AssetTypeEnum

0 = successful

1000 = errors occurred

Creates the specified number of new Expiration objects with the specified asset type and ID in memory

assetID

string

total

int

External

Parameters

Method Name

Name

Data type (in C#)

Expiration.ReturnObject.ReturnCode

Description

NewExpiration

tokenValue

string

0 = successful

1000 = errors occurred

Creates a new Expiration object with the specified asset type and ID in memory

assetType

AssetTypeEnum

assetID

string

NewExpirations

tokenValue

string

0 = successful

1000 = errors occurred

Creates the specified number of new Expiration objects with the specified asset type and ID in memory

assetType

AssetTypeEnum

assetID

string

total

int

Expiration.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List<string>

2

ErrorObjectIndexList

List<int>

3

Exceptions

List<Exception>

4

ReferenceObjects

List<Expiration>

5

ReturnCode

int

6

TraceMessages

List<string>

7

WarningMessages

List<string>

ExpirationUpdateInfo object

  • Data types (in C#) for all properties are bool.

  • Set the property to true to update the corresponding Expiration property.

Property Name

1

AssetID

2

AssetType

3

CityCode

4

CityNameStateCounty

5

Completed

6

CompletionDate

7

CreatedOn

8

Description

9

ExpirationCode

10

ExpirationStartDate

11

MilesToExpiration

12

MoveNumber

13

Priority

14

RouteTo

15

UpdatedBy

16

UpdatedOn