Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The book job object contains all relevant properties to book a new work order. This is currently used within ServiceMobility to schedule follow-up service when a subsequent visit is required.


Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:


Book Job Object Formats

Include Page
_Book Job Object Formats
_Book Job Object Formats

Book Job Object Properties

(info)(info) Required properties are in bold

PropertyTypeDescription
Accountobject

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 AccountNum property to the work order object. The system will automatically expand the account object with the existing account information.

Code Block
languagexml
titleExample Managed Account XML Fragment
<Account AccountNum='12345'></Account>

When any additional properties beyond the AccountNum are specified the system assumes it is an ad-hoc account.

  • The system will NOT verify the AccountNum for ad-hoc accounts
  • The system will NOT create any new Account Objects in the system 
  • The account information is passed straight through to the mobile

Code Block
languagejs
titleExample 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 AccountNum does refer to an existing account in the system. This option is useful in cases where a contact might be added or changed for just a single visit.

Assetscollection

Contains a collection of Asset Objects associated with the account location (address).

Status
title3.34.0

FlexAttrsobject

Include Page
_def_FlexAttrs
_def_FlexAttrs

Status
colourGrey
title3.31.0

FlexFormscollection

Include Page
_def_FlexForms
_def_FlexForms

Status
colourGrey
title3.31.0

Locationobject

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.

  • The system will NOT verify the LocationNum for ad-hoc accounts
  • The system will NOT create any new AccountLocation objects in the system
  • The account location information is passed straight through to the mobile 

See: 

REST Object Definitions Account Location Related Objects

Account Location Object

OrderTypestringSpecifies the work order type (see REST System Categories Work Order Types in system categories).
OriginalOrderNumstringSpecifies the original work order number.
RequiredPartscollectionProvides the ability to specify all parts required to complete the work order (see
REST Object Definitions Work Order Activity Related Objects Required Parts
Required Part Object).

TimeConstraints

array

Specifies zero or more TimeConstraint objects. Time constraints informs the mobile worker when the customer is available or not available.

Status
colourGrey
title3.16.0

UrgencystringSpecifies the urgency associated with the part order.

UserNamestring

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

Status
colourGrey
title3.19.0