Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

The Asset object contains properties related to a specific asset. An asset is specifically tracked piece of equipment usually located as a customer location.


Asset Object Formats

JSON Format
{
	"AccountNum": "",
	"AssetNum": "",
	"Delete": false,
    "Cost": 25.0,
	"Desc": "",
	"FlexForms": [
		"${FlexFormID}"
	],
	"FlexFormsDisplayValues": [{
        "FlexFormID": "${FlexFormID}",
        "Title": "",
            "FlexGroups": [{
                "Title": "",
                "FlexAttrs": [{
                    "FlexAttrID": "${FlexAttrID}",
                    "Label": "label text",
                    "Value": "value text"
                }]
            }]
    }],
	"FlexView": [{
		"Title": "GroupName1",
		"Items": [{
			"Label": "labeltext",
			"Value": "valuetext"
		}]
	}],
	"History": [{
		"FlexView": [{
			"Title": "GroupName",
			"Items": [{
				"Label": "labeltext",
				"Value": "value text"
			}]
		}],
		"Items": [{
			"ID": "",
			"AssetNum": "",
			"BatchNum": "",
			"FlexView": [{
				"Title": "GroupName",
				"Items": [{
					"Label": "labeltext",
					"Value": "valuetext"
				}]
			}],
			"GeneralIncomeAccount": "1001",
			"IsChargeable": false,
			"IsRet": false,
			"NonTaxable": false,
			"Price": 0,
			"PriceOverrideFlag": true,
			"ProdAttrs": {
				"Desc": "",
				"IsBatch": false,
				"IsInvCtrl": false,
				"IsSerialized": false,
				"ProdType": "1001"
			},
			"ProdNum": "1001",
			"Qty": 0,
			"RefCode": "",
			"ReturnReasonCode": "",
			"SerialNum": "1001001",
			"StorageLocationID": "",
			"Delete": false
		}],
		"Notes": [{
			"ID": "",
			"Author": "",
			"Date": "",
			"ReadOnly": true,
			"Text": "",
			"Delete": true
		}],
		"OrderDate": "",
		"OrderNum": "",
		"OrderType": ""
	}],
	"InServiceDate": "",
	"IsComponent": false,
	"LastServiceDate": "",
	"Location": "",
	"LocationNum": "",
	"Mfg": "",
	"Model": "",
	"ParentAssetNum": "",
	"ProdNum": "",
	"RetailerID": "",
	"RetailerName": "",
	"SerialNum": "",
	"ServiceCodes": [],
 	"ServiceCodesDesc": [],
	"Status": "",
	"Type": "",
	"VerificationAPI": {
        "IsVerified": false,
        "VerificationDate": "2018-12-15T10:00:00.001Z"
    },
    "VerificationQR": {
        "IsVerified": false,
        "VerificationDate": "2018-12-15T10:00:00.001Z"
    }
}

Asset Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
AccountNumstringWhen the asset is associated with an Account Location, the AccountNum field represents the ID of the associated Account. When set, the LocationNum field must also be set.
AssetNumstringThis property uniquely identifies the asset and can be composed of alpha, numerics, and most special characters.
AssetSubTypestring(warning) This property is for future use and currently is not used.
FlexAttrsobject

This property contains the FlexAttr values that were entered.

PropertyTypeDescription
${FlexFormID}object

Identifies the FlexForm

PropertyTypeDescription
${FlexAttrID}array

Contains an collection of values entered for the FlexAttr field identified by ${FlexAttrID}.

FlexFormsobject

An optional collection of FlexForm IDs. Each form specified in the collection will be available for the identified task.

See: FlexForm Object

(3.12)

FlexViewobject

The optional FlexViews object is used to provided additional read-only details and information specific to the object they are included in. The FlexViews are fully customizable by the customer.

See: Flex Views Object

Historyobject

An optional property in which it is possible to store one or more collections, containing service history details for the asset. When used, each item in the collection should be used to store details of a work order.

Alternatively, instead of adding service history information to the Asset object, the Asset Service History REST API Interface can optionally be used, allowing ServiceMobility to obtain the service history data for assets from a 3rd party system containing the relevant details. 

PropertyTypeDescription
FlexViewobject

The optional FlexViews object is used to provided additional read-only details and information specific to the object they are included in. The FlexViews are fully customizable by the customer.

See: Flex Views Object

Itemscollection

The Items collection contains line item details for the work order. Line items include parts used, parts returned, travel codes, labor codes, etc. Line items are grouped based on the line item type identified by the ProdAttrs.ProdType property.

See: Item Object

Notescollection

The Notes object contains an optional collection of notes associated with the work order. These can be recorded by anyone involved with taking and booking the work order. Notes are internal and not meant to be displayed to the Customer

OrderDatedatetimeThe UTC date and time when the work order was created.
OrderNumstringThe order number associated with the work order.
OrderTypestringContains a Work Order Types System Category value identifying the type of work order.
InServiceDatedatetimeThe UTC date and time when the asset was originally placed in service.
IsComponentboolean

Identifies if this asset is a component of another asset.

Valid values are:

  • true = This asset is considered a component of another asset
  • false = This asset is not a component of another asset
LastServiceDatedatetimeThe UTC date and time when the asset was last serviced
LocationstringAn open text field that can be used by the customer to describe the physical location of where the asset was installed.
LocationNumstringWhen the asset is associated with an Account Location, the LocationNum field represents the ID of the associated Location. When set, the AccountNum field must also be set.
MfgstringIdentifies the manufacture of the asset.
ModelstringIdentifies the manufacture's model number of the asset.
ProdNumstringOptionally identifies a corresponding item in the product catalog.
SerialNumstringIdentifies the serial number of the asset.
DescstringContains a brief description of the asset.
StatusstringContains an Asset Status Codes system category value identifying the current state of the asset.
ServiceCodesobject

An optional collection of service code IDs. The first service code ID specified in the collection is the top level service code, the second service code ID specified in the collection corresponds with the second level service code, etc. There may be a maximum of 7 levels of service codes defined.

See: Service Code Object

ServiceCodesDesccollection

This optional collection contains the description for service codes.

The order the descriptions appear in the array are the order mobile worker has selected service codes in the mobile application.

3.33.0
TypestringContains an REST System Categories Asset Types system category value identifying the type of asset.
VerificationAPIobject

Captures response of Asset's Model Number Verification in Work Order process. Mobile worker can verify asset installed at the account location when Rules.CanVerifyAsset is true in Work Order Object.

PropertyTypeDescription
IsVerifiedboolean

Identifies if the mobile worker verified asset information.

Valid values are:

  • false = Asset verification failed
  • true = Mobile worker verified asset

VerificationDate

datetimeThe date and time, in UTC format, when the asset verification was attempted.

3.35.0

VerificationQRobject

Captures response of Asset Verification by scanning QR code in Work Order process. Mobile worker can verify asset installed at the account location when rules Rules.CanVerifyAsset is true and Rules.CanScanQRCode is true in Work Order Object.

PropertyTypeDescription
IsVerifiedboolean

Identifies if the mobile worker verified asset information.

Valid values are:

  • false = Asset verification failed
  • true = Mobile worker verified asset

VerificationDate

datetimeThe date and time, in UTC format, when the asset verification was attempted.

3.35.0

Deleteboolean

Optional property.

This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request.

  • No labels