14.1 Job Rebook Push Notifications
- Billy Sewell (Unlicensed)
Background
This Push Notification can be used to inform an external system whenever a job is rebooked in ServiceOptimizer.
Triggers
When configured (see below), a Job Rebook push notification is sent whenever a job is rebooked in ServiceOptimizer via the following APIs:
- 14.1 Book Appointment SOAP API
- 14.1 Book Non-Appointment Job SOAP API
- 14.1 Book Dependency Group Job SOAP API
That is, when a job is booked using the above APIs, and:
- For the 14.1 Book Appointment SOAP API and the 14.1 Book Non-Appointment Job SOAP API:
- The
jobIDvalue already exists in the system; and - The
allowRebookparameter was supplied with a value oftruein the API call.
- The
- For the 14.1 Book Dependency Group Job SOAP API:
- The
multiJobIDvalue already exists in the system; and - The
AllowRebookAllparameter was supplied with a value oftruein the API call.
- The
Configuring
Job Rebook 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 Rebook 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_rebook | boolean | Defines if Job Rebook push notifications will be sent or not. |
Object Format
The Job Rebook push notification will send a JSON object to the configured API with the following format:
{
"Type": "9",
"WorkItemType": "1",
"WorkItem": {
"Id": ""
"WorkStatus": ""
}
}
Object Properties
The Job Rebook 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 Rebook push notification, this value will always be 9 (nine), indicating the notification represents a rebook action. Prior to ServiceScheduling 13.0, the value for | |
WorkItemType | string | Yes | The type of work the notification is about. For a Job Rebook 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 Rebook push notification is about. | |
WorkStatus | string | Yes | A DisStatus code, representing the status of the job at the time of the Job Rebook push notification. | |