Work Item Object Format
Work Item Object Properties
| Property | Type | Required? | Description | Field Mappings | ||
| ServiceDispatch | ServiceMobility | ServiceScheduling | ||||
|---|---|---|---|---|---|---|
Assets | array | No | An array of Asset objects, representing properties related to items of physical equipment (i.e. assets) that are associated with the Work Item (e.g. normally, assets located at the location of the Work Item). | Assets | ||
AtRisk | object | No | An At Risk object, representing the "at risk" status of the Work Item. | |||
Booking | object | No | A Booking object, representing details of the Work Item related to when the Work Item was created, when it is scheduled to be carried out, who will be performing the work, etc. | |||
| CancelDate | Datetime | Scheduling job cancellation timestamp | cancelDate | |||
| Claims | array | The Claims object used within the ServiceMobility work order | /Claims | |||
Desc | string | No | A short description of the Work Item. | ProbDesc | /Description | desc(bookJob) vs actNotes (getJob) |
| Extensions | object | No | his 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 passing additional data around the system. **Currently, this is only used for GET WorkItem requests and is dynamically generated. | |||
FlexView | array | No | An array of FlexView objects, representing associated flexible "extra" items of information associated with the Work Item. | /FlexViews | When desc2 contains "more notes" it is mapped to the FlexViews property | |
Flags | object | No | A Flags object, representing various boolean flag values of the Work Item. | |||
Id | string | No | The ID of the Work Item. | (mfgId:CallNo -> OrderNum) | /OrderNum | JobId |
| JobSourceInfo | The JobSourceInfo property provides the originating source of the job. This field will provide SM for ServiceMobility, SS for ServiceScheduling, or SD for ServiceDispatch. | |||||
| LastModifiedDate | Datetime | Last modified UTC timestamp | UpdatedOnUTC (SD→CDM only) | |||
Location | object | No | A Location object, representing the location of the Work Item. | /ConsumerInfo | /Location | /customer |
Notes | string | No | Any notes associated with the Work Item. | /Notes[] |
| |
Payment | array | No | An array of Payment objects, representing payment information associated with the Work Item. | /ServiceContracts | ||
| Photos | array | No | An array of Photo objects | /Photos | ||
Priority | string | No | A representation of the priority (importance) of the Work Item.
| /Priority | priority(0-99) | |
| RejectReasonCode | string | No | This optional object contains the reason why the mobile worker rejected the work order. | |||
| RejectReasons | object | No | The RejectReasons object provides an override within ServiceMobility for the standard reject reasons within the system categories. | |||
| RepairLocation | object | No | Contains the repair location for the job | /RepairLocation | ||
| ServiceProvider | object | No | The ServiceProvider object | |||
| Stage | integer | |||||
TimeConstraints | array | No | An array of TimeConstraint objects, representing any constraints relating to when the Work Item can be performed. | /TimeConstraints | ||
Type | string | No | The Work Item's type of work (i.e. Job, Break or Activity). | |||
WorkStatus | integer | No | A code representing the status of the Work Item.
| CallStatus | /OrderStatus | disStatus |
WorkSubStatus | integer | No | An optional, unchecked sub-status code from the relevant sub-system. | CallSubStatus | ||
WorkType | object | No | A WorkType object, representing the type of work that the Work Item relates to in more detail than the Type field. | |||
The ServiceBroker Work Item Object Priority Property Values
| Value | Description | ServiceMobility | ServiceScheduling |
|---|---|---|---|
0 | Low | 1001 | 0-9 |
1 | Low | 1001 | 10-19 |
2 | Low | 1001 | 20-29 |
3 | Medium | 1002 | 30-39 |
4 | Medium | 1002 | 40-49 |
5 | Medium | 1002 | 50-59 |
6 | Medium | 1002 | 60-69 |
7 | High | 1003 | 70-79 |
8 | High | 1003 | 80-89 |
9 | High | 1003 | 90-99 |
WorkStatus Property Values
| Value | Description | ServiceDispatch | ServiceMobility | ServiceScheduling | Notes |
|---|---|---|---|---|---|
0 | Eamarked/Pending | OPEN | 9 | Earmarked | The Work Item is in a pending status awaiting the Worker to either accept or reject it. |
10 | Contacted/Acknowledged/Accepted | ACCEPTED | 1 HUB: 9 - New | Contacted | The Work Item has been accepted by the Worker. |
20 | En Route | EN ROUTE | 6 | Travelling | The Worker is en route (traveling) to the customer location. |
30 | Travel Complete | 8 | The Worker has completed travel to the location although they may not yet be onsite. This can happen when the Worker has to park some distance away from the actual service location. | ||
40 | Onsite | ONSITE | 7 | LoggedOn | The Worker has arrived onsite at the customer location. |
50 | Offsite | The Worker has left the site of the customer location. | |||
60 | Closed Complete | COMPLETED | 4096 | Cleared | The Worker has completed the Work Item and marked it as completed. |
70 | Closed Incomplete | RESCHEDULED | 4097 | LoggedOff | The Worker has marked the Work Item as closed but incomplete. |
80 | Rejected | REJECTED | 1001 | The Worker has rejected the Work Item. | |
| 82 | Consumer | ||||
100 | Claimed | CLAIMED | The Work Item is in claimed status. | ||
-1 | Cancelled | CANCELLED | |||
-9 | Tentative | Tentative (0) |  Tentative/Fixed are not mapped. |