Service History Object

Service History Object Formats

JSON Format

{
	"_t" : "assetHistory",
	"_v" : "1.0",
	"History": [
		{
			"Account": {
				"AccountNum": "", 
				"Name": ""
			},
    		"ActualEndDate": "",
    		"ActualStartDate": "",
    		"FlexAttrs": "",
    		"FlexForms": [
        		"${FlexFormID}"
    		],
			"Items": [],
			"Location": {
				"Address": {
            		"AddrLine1": "", 
            		"AddrLine2": "", 
            		"AddrLine3": "", 
            		"AddrLine4": "", 
            		"AddrType": "", 
            		"City": "", 
            		"Country": "", 
            		"Region": "", 
            		"Zip": ""
        		},
				"LocationNum": "",
				"Name": ""
			},
    		"Notes": [
        		{
            		"Author": "", 
            		"Date": "", 
            		"Text": ""
        		}
    		],
    		"OrderDate": "",
    		"OrderNum": "",
    		"OrderStatus": "",
    		"OrderSubStatus": "",
    		"OrderType": "",
    		"PrimaryUserName": "",
    		"ReasonCode": "",
    		"Rules": {
				"IsOps": true
			}
    		"ServiceCodes": [],
    		"Status": "",
    		"Type": "",
    		"UserName": ""
		}
	]
}

Service History Object Properties

Required properties are in bold.

Property Type Description

Account

object

The Account Object object is used to identify the account the work order is assigned to. Account object will store Account Number and Name properties.

ActualEndDate datetime Identifies the actual date and time the work order was completed.

ActualStartDate datetime Identifies the actual date and time the work order was started on site at the account location. This value does not include the start travel time.

FlexAttrs

object

This property contains the FlexAttr values that were entered.

FlexAttrs are always associated with a FlexForm
FlexAttrs values can be pre-populated from the backend

Property

Type

Description

${FlexFormID}

object

Identifies the FlexForm

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

FlexForm

object

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

See: FlexForm Object

Items

object

The Items object contains line item details for the asset. 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

Location

object

The account location identifies the actual location (address) of where the service was performed. For residential customers this is typically the same as the account information. However, there are cases such as in the auto insurance industry where this could be an auto body shop where a vehicle was towed after an accident. Location object will store Address, Location Number and Name properties.

See: Account Location Object

Notes

collection

The Notes object contains an optional collection of notes associated with the asset. 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

OrderDate datetime The UTC date and time when the work order was created.

OrderNum string The order number associated with the work order.

OrderStatus

string

Identifies the current status of the work order.

Valid values are:

4097 - Closed / Incomplete
4096 - Closed / Complete

OrderSubStatus string Identifies the current sub-status of the work order.

OrderType

string

Contains a Work Order Type System Category value identifying the type of work order.

Valid values are:

1001 – Install (default)
1002 – Inspection
1003 – Maintenance
1004 – De-Install
1005 – Repair
1006 – Demo
1007 – Training

PrimaryUserName string Identifies the primary mobile worker for the work order. This field is used in cases where multiple mobile workers are dispatched to the same location. In this case this property should be set to the mobile worker that is primary. If this field is set and the mobile worker is not the primary then certain mobile business processes may be restricted (please refer to the mobile application user guide).

ReasonCode

string

If the work order was closed and marked incomplete, then it will contain a Work Order Closed-Incomplete Reasons (no follow up required) system category value.

If the work order was closed and marked complete, then it will contain a Work Order Closed Complete Reasons system category value.

Notes:

The closed-incomplete selection will only be visible if the Work Order Closed-Incomplete Reasons (no follow up required) system category has been configured
The closed-complete selection will only be visible if the Work Order Closed Complete Reasons system category has been configured

Rules

object

This property contains rules (flags) that control different aspects of the work order process.

Property

Type

Description

IsOps

boolean

Default value is false

Identifies if the work order is under ServiceOperations control.

If true, then

the work order was created by ServiceOperation
Either ServiceOperations or the Servicer can update the work order
ServiceOperations can remove the work order (un-assign it) from the Servicer
Only ServiceOperations can delete the work order

3.16.0

Status string Identifies the current state of the asset. This is an open property that can be used by the Customer as they see fit.

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

UserName string This property identifies the ID of the mobile worker that has been assigned to the work order.