Document toolboxDocument toolbox

Warranty Constraint Object

The Warranty Constraint object contains properties related to a specific warranty constraint. Mobile application will evaluate criteria specified in eligible warranty constraint before allowing mobile worker can change work order's "In Warranty" status.


On this page:

Related pages:

Warranty Constraint Object Formats

JSON Format
{
	"AgeRange": {
		"Start": 12,
		"End": 35
	},
	"AssetType": "",
	"ConstraintType": "",
	"Deleted": false,
	"Extensions": {
		"FactoryProgCode": ""
	},
	"ID": "",
	"Message": {
		"en": ""
	},
	"ModifiedUTC": "",
	"Pattern": "",
	"Priority": 1
}

Warranty Constraint Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
AssetAgeobject

This properly contains minimum age and maximum age definition for asset's age criteria. Age in days is calculated based on the asset install date.

PropertyTypeDescription
StartintegerIdentifies asset's minimum age in days. If minimum age is specified, the asset age in days must be greater or equal to the specific minimum age. 
EndintegerIdentifies asset's maximum age in days. If maximum age is specified, the asset age in days must be less than or equal to the specified maximum age.
AssetTypestring

Contains an Asset Types system category value identifying the type of asset.

(warning) This property is for future use and currently is not used.

ConstraintTypestring

This property identifies the type of constraint.

Valid values are:

  • 1001 - Asset
Deletedboolean

Identifies if the warranty constraint is to be deleted.

Valid values are:

  • true - The warranty constraint object should be deleted
  • false - The warranty constraint object should not be deleted. This is the default value if this property is not specified.
Extensionsobject

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.

IDstringThis property uniquely identifies the warranty constraint in the system.
MessageobjectThis property contains a list of warranty constraint message for each required language. Each member pair consists of the language identifier (left side) and the text for the language (right side). Mobile application will display message when work order fails to satisfy a warranty constraint.
ModifiedUTCdatetime

The date and time, in UTC format, when this object was last modified.

Patternstring

Regular expression for the manufacture's model number for the asset associated with the work order.

This object uses the .NET/C# regular expression engine.

Priorityinteger

Identifies the priority of the warranty constraint. Mobile application will apply highest Priority constraint in case multiple warranty constraints are eligible for "In Warranty" criteria evaluation.

Highest number has the highest priority.