Expiration object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

Expirations are records of important activities and out-of-service dates for such things as driver vacations and equipment maintenance. Some are designed to notify dispatchers of time periods during which resources are unavailable to be used on trips. Other expirations are used to indicate that resources have a planned activity that does not affect dispatch. The system will check for resource expirations when you make resource assignments. If the resource has a required expiration in effect, you will not be allowed to plan or start the resource on any trips having times that conflict with it.

External methods

The Return Value for all methods is Expiration.ReturnObject.

Method Name	Parameters	Expiration.ReturnObject.ReturnCode	Description
	Name	Data type (in C#)
NewExpiration	tokenValue	string	0 = successful 1000 = errors occurred	Authenticates the token value and creates a new Expiration object in memory with the specified asset type and ID in memory
	assetType	AssetTypeEnum
	assetID	string
NewExpirations	tokenValue	string	0 = successful 1000 = errors occurred	Authenticates the token value and creates the specified number of new Expiration objects with the same specified asset type and ID in memory
	assetType	AssetTypeEnum
	assetID	String
	total	int

Method Name

Parameters

Expiration.ReturnObject.ReturnCode

Description

Name

Data type (in C#)

NewExpiration

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates a new Expiration object in memory with the specified asset type and ID in memory

assetType

AssetTypeEnum

assetID

string

NewExpirations

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates the specified number of new Expiration objects with the same specified asset type and ID in memory

assetType

AssetTypeEnum

assetID

String

total

int