Work Order Alert Object Formats
| Include Page | ||||
|---|---|---|---|---|
|
Work Order Alert Object Properties
Required properties are in bold.
| Property | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AlertID | string | This property uniquely identifies the work order alert | |||||||||
| AssetAge | object | This properly contains minimum age and maximum age definition for asset's age criteria. Age in months is calculated based on the asset install date.
Note: The calculated age in months is to be rounded down to nearest month - 12 months and 29 days is rounded down to 12 months | |||||||||
AssetType | string | Contains an Asset Types system category value identifying the type of asset. | |||||||||
| ConcessionID | string | Identifies concession associated with work order alert. The concession will be applied to the work order when mobile worker accepts/acknowledges alert in the work order process.
| |||||||||
Deleted | boolean | Identifies if the work order alert is to be deleted. Valid values are:
| |||||||||
| Extensions | object | This object contains an optional collection of key/value pairs. These key/value are defined and controlled by the customer and are typically used to assist in integration by pass additional data around the system. | |||||||||
| FixedCharges | collection | The fixed charges collection contains one or more optional charges associated with work order alert. The fixed charges will be applied to the work order when mobile worker accepts/acknowledges alert in the work order process.
| |||||||||
| IsActive | boolean | Default value is Identifies if the work order alert is active and can be used in mobile application. Valid values are:
| |||||||||
| InWarranty | boolean | This flag indicates if the mobile application needs to apply warranty criteria (in/out of warranty) for work order alert. Valid values are:
| |||||||||
Message | string | This property contains information text to be displayed in alert/notification. This property will override default message in alert template. | |||||||||
| ModelNumPattern | string | Regular expression for the manufacture's model number for the asset associated with the work order.
| |||||||||
| ModifiedUTC | datetime | The date and time, in UTC format, when this object was last modified. | |||||||||
| PartialServiceCodeMatch | boolean | This flag indicates if the service code supplied in the Alert will match the beginning of the asset service code. Valid values are:
| |||||||||
| ProdNumPattern | string | Regular expression for the product number(s) of the product. A product number collection can be specified as regular expression. For example, the regex pattern:
will match product numbers 1001, 1002, 1003, 1004, 1005 and 1006 for a product.
| |||||||||
| SerialNumPattern | string | Regular expression for asset serial number. The mobile application will use regular expression to check if asset serial number is in specified range. Here are few examples demonstrating serial number range represented as regex pattern.
| |||||||||
| ServiceCodes | collection | A collection of service codes to match for work order alert constraints Note: A service code is a collection of strings, so this object is a collection of collections | |||||||||
| SetInWarranty | boolean | Identifies whether the work order will be automatically changed to in warranty when the criteria are met. Valid values are:
| |||||||||
TemplateID | string | This property uniquely identifies the alert template associated with work order alert. | |||||||||
| URL | string | This property contains URL to an external web site. This property will override default URL in alert template. |
This object uses the .Net