ExpirationService
First available in SystemsLink: 2017.3.0
ExpirationService includes methods for creating, retrieving, and deleting expirations by type and Id.
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.
Endpoint Address: [SystemsLinkRootUrl]/ExpirationService.svc
Methods
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
Delete |
expirationId |
string |
void |
Delete the expiration specified by expirationId. |
Get |
objectType |
ExpirationObjectType |
List<Expiration> |
Retrieve all expirations of the supplied ExpirationObjectType with the matching id. |
objectId |
string |
|||
GetActive |
objectType |
ExpirationObjectType |
List<Expiration> |
Retrieve all active expirations of the supplied ExpirationObjectType with the matching id. |
objectId |
string |
|||
NewItem |
Expiration |
Create a new expiration. |
||
Save |
data |
Expiration |
Expiration |
Save an expiration. |
Properties and column mapping
| Columns in Database column Name are from the expiration database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
Code |
string |
exp_code |
varchar(6) |
|
Completed |
bool |
exp_completed |
char(1) |
Value is "Y" or "N" |
ControlData |
string |
Not mapped to database. |
||
CreatedBy |
string |
Not mapped to database. |
||
CreatedDateTime |
DateTime? |
exp_creatdate |
datetime |
|
Description |
string |
exp_description |
varchar(100) |
|
EndDate |
DateTime? |
exp_compldate |
datetime |
|
ExpirationId |
string |
exp_key |
int |
|
ObjectId |
string |
exp_id |
varchar(13) |
|
ObjectType |
ExpirationObjectType |
exp_idType |
char(3) |
|
Priority |
string |
exp_priority |
varchar(6) |
|
RuleData |
List<ConcurrencyFieldRule> |
datetime |
Not mapped to database. |
|
StartDate |
DateTime? |
exp_expirationdate |
datetime |
|
UpdateDateTime |
DateTIme? |
exp_updateon |
datetime |
|
UpdatedBy |
string |
exp_updateby |
varchar(20) |
|
ExpirationObjectType properties
| Members | Comments |
|---|---|
Driver |
Represents the expiration object type of Driver. String representation is "DRV." |
Tractor |
Represents the expiration object type of Tractor. String representation is "TRC." |
Trailer |
Represents the expiration object type of Trailer. String representation is "TRL." |
Carrier |
Represents the expiration object type of Carrier. String representation is "CAR." |
Company |
Represents the expiration object type of Company.String representation is "CMP." |
ThirdParty |
Represents the expiration object type of ThirdParty. String representation is "TPR." |
Order |
Represents the expiration object type of Order. String representation is "ORD." |