14.1 Job Confirm Push Notifications
- Billy Sewell (Unlicensed)
Background
This Push Notification can be used to inform an external system whenever a job is confirmed in ServiceOptimizer.
Triggers
When configured (see below), a Job Confirm push notification is sent whenever a resourced job is confirmed in ServiceOptimizer via:
- The User Interface in ServiceGANTT; or
- The 14.1 Update Non-Appointment Job SOAP API API.
Configuring
Job Confirm push notifications can be enabled/disabled by setting the flag value shown below in the sp213_scheduler_parameters database table for the relevant FRU (or, enabled/disabled globally by setting the value in the sp083_system_parameters database table).
Remember that before enabling Job Confirm push notifications, details of where to send the notifications also needs to be set up. Please see the 14.1 Push Notifications page for details.
| Column Name | Type | Description |
|---|---|---|
notification_job_confirmation | boolean | Defines if Job Confirm push notifications will be sent or not. |
Object Format
The Job Confirm push notification will send a JSON object to the configured API with the following format:
{
"Type": "7",
"WorkItemType": "1",
"WorkItem": {
"Id": "",
"WorkStatus": ""
}
}
Object Properties
The Job Create push notification's JSON object has the following properties.
| Property | Type | Required? | Description | |
|---|---|---|---|---|
Type | string | Yes | The type of notification being sent. For a Job Confirm push notification, this value will always be 7 (seven), indicating the notification represents a confirmation action. | |
WorkItemType | string | Yes | The type of work the notification is about. For a Job Confirm push notification, this value will always be 1 (one), indicating the notification is about a job. | |
WorkItem | object | Yes | ||
Id | string | Yes | ServiceOptimizer's unique ID for the job that the Job Confirm push notification is about. | |
WorkStatus | string | Yes | A DisStatus code, representing the status of the job at the time of the Job Confirm push notification. | |