Book Job Object Formats
Book Job Object Properties
Required properties are in bold
| Property | Type | Description |
|---|---|---|
| Account | object | The REST Object Definitions Account Location Related Objects Account Object object is used to identify the account the to book the work order against. Work orders can be created against managed accounts or ad-hoc accounts. Managed accounts are those that exist in our system out side of a work order. They are managed either through the web based management application or through the Account REST API. To use a managed account, add just the Example Managed Account XML Fragment <Account AccountNum='12345'></Account> When any additional properties beyond the
Example ad-hoc Account JSON Fragment {
"Account": {
"AccountNum": "",
"AccountType": "1001",
"Addresses": [
{
"AddrLine1": "123 Main Street",
"AddrLine2": "",
"AddrLine3": "",
"AddrLine4": "",
"AddrType": "1001",
"City": "McLean",
"Country": "",
"Intersection": "",
"Lat": "",
"Lon": "",
"Region": "",
"Zip": "22102"
}
],
"Contacts": [
{
"Email": "",
"FirstName": "",
"IsPrimary": true,
"LastName": "",
"Phones": [
{
"PhoneNum": "",
"PhoneType": ""
}
]
}
],
"Name": "Smith Home"
}
}
It is possible to use an existing managed account and override any property value for a single work order. In this case it works just like an ad-hoc request. The only difference is that the |
| Assets | collection | Contains a collection of Asset Objects associated with the account location (address). 3.34.0 |
| FlexAttrs | object | This property contains the FlexAttr values that were entered. 3.31.0 |
| FlexForms | collection | An optional collection of FlexForm IDs. Each form specified in the collection will be available for the identified task. See: FlexForm Object 3.31.0 |
| Location | object | The account location identifies the actual location (address) of where the service is to be completed. 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. The Work Order API supports using managed Account Locations as well as ad-hoc Account Locations. Managed Account Locations are those that exist in our system out side of a work order. They are managed either through our Portal Web Application or through the Account Location REST APIs. When using a manage account location, the only property that can be filled in is the LocNumber. The system will automatically expand this object with the existing account location information. Ad-hoc Account Locations When any additional properties beyond the LocationNum are specified the system assumes it is an ad-hoc account.
See: REST Object Definitions Account Location Related Objects Account Location Object |
| OrderType | string | Specifies the work order type (see REST System Categories Work Order Types in system categories). |
| OriginalOrderNum | string | Specifies the original work order number. |
| RequiredParts | collection | Provides the ability to specify all parts required to complete the work order (see REST Object Definitions Work Order Activity Related Objects Required Parts Object). |
TimeConstraints | array | Specifies zero or more TimeConstraint objects. Time constraints informs the mobile worker when the customer is available or not available. 3.16.0 |
| UserName | string | This property identifies the ID of the mobile worker that has been assigned to the original work order. 3.19.0 |