Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SCHUD and version 13.1

...

(warning) Remember that before enabling Job Rebook push notifications, details of where to send the notifications also needs to be set up. Please see the Admin ServiceOptimizer System Configuration Push Notifications page for details.

Column NameTypeDescription
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:

Code Block
{
	"Type": "29",
	"WorkItemType": "1",
	"WorkItem": {
		"Id": ""
		"WorkStatus": ""
	}
}

...

The Job Rebook push notification's JSON object has the following properties.

PropertyTypeRequired?Description
TypestringYes

The type of notification being sent.

For a Job Rebook push notification, this value will always be

2

9 (

two

nine), indicating the notification represents a rebook action.

Note

Prior to ServiceScheduling 13.0, the value for Type was 2 (two). Please see the Upgrade Advisory Notice 13.0 page.

WorkItemTypestringYes

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.

WorkItemobjectYes

IdstringYesServiceOptimizer's unique ID for the job that the Job Rebook push notification is about.

WorkStatusstringYesDisStatus code, representing the status of the job at the time of the Job Rebook push notification.