Status

colour	Green
title	3.19.0

Status

colour	Yellow
title	3.19.1

Status

colour	Yellow
title	3.23.0

The Work Order Alert REST API is used to create, get, update or delete alert objects. This API facilitates import of Work Order Alert (Special Notifications) data into the system for mobile worker's deployment group. The preconditions for special notifications are:

The work order rule associated with special notifications is set to true within the work order.
Special Notifications data has been imported into to the system for the technician's deployment group.

The mobile worker will receive pop-up notifications in mobile application for the following special conditions:

Safety reminders
Product recalls
Return part for engineering autopsy

Some notifications require the technician to input a free form text response.

Panel

borderColor	grey
bgColor	whitesmoke

On this page:

Table of Contents

maxLevel	2

Related pages:

REST Object Definitions Work Order Activity Related Objects Work Order Alert Object

Resource URL Summary

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

Retrieve the details of a specific Work Order Alert

GET /seiapi/v3/WorkOrder/Alerts/${AlertID}

Insert or Update the details of a specific Work Order Alert

PUT /seiapi/v3/WorkOrder/Alerts/${AlertID}

Insert or Update the details of a specific Work Order Alert for a Service Area

PUT /seiapi/v3/WorkOrder/ServiceArea/${ServiceAreaID}/Alerts/${AlertID}

Bulk Insert or Update the details of specific Work Order Alerts

POST /seiapi/v3/WorkOrder/Alerts

Bulk Insert or Update the details of specific Work Order Alerts for a Service Area

POST /seiapi/v3/WorkOrder/ServiceArea/${ServiceAreaID}/Alerts

Delete a specific Work Order Alert

DELETE /seiapi/v3/WorkOrder/Alerts/${AlertID}

API Specific Parameters

Parameter	Description
`${AlertID}`	Identifies the REST Object Definitions Work Order Activity Related Objects Work Order Alert Object.

${ServiceAreaID} Identifies the Service Area Object.

API Specifics

Panel

borderColor	#D3D3D3

Retrieve the details of a specific Work Order Alert

This REST API will return a Work Order Alert with the specified ID. The Work Order Alert with the specified ID must already exist in the system.

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

GET /seiapi/v3/WorkOrder/Alerts/${AlertID}

HTTP Request Body

This request does not require a request body.

HTTP Response

On success, an HTTP status code of 200 will be returned, and the response body will contain an REST Object Definitions Work Order Activity Related Objects Work Order Alert Object . Otherwise, on error, the response body will contain a descriptive reason for the error.

Include Page

	_Work Order Alert Object Formats
	_Work Order Alert Object Formats

Include Page

_Default Response Object on Error

Panel

borderColor	#D3D3D3

Insert or Update the details of a specific Work Order Alert

This REST API will insert a new Work Order Alert with the specified ID into the system, if an Work Order Alert with the specified ID does not already exist in the system.

If, however, the Work Order Alert with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Work Order Alert with the specified ID with the details of the Work Order Alert supplied in the HTTP Request Body.

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

PUT /seiapi/v3/WorkOrder/Alerts/${AlertID}

HTTP Request Body

The HTTP request body must contain a valid Work Order Alert Object.

HTTP Response

On success the API will return a response code of 200.

_Default Response Object OnlyWork Order Alert Object.

HTTP Response

On success the API will return a response code of 200.

Panel

borderColor	#D3D3D3

Insert or Update the details of a specific Work Order Alert for a Service Area

This REST API will insert a new Work Order Alert with the specified ID into the system for a Service Area, if an Work Order Alert with the specified ID does not already exist in the system. The Service Area with the specified ID must already exist in the system.

If, however, the Work Order Alert with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Work Order Alert with the specified ID with the details of the Work Order Alert supplied in the HTTP Request Body.

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

PUT /seiapi/v3/WorkOrder/ServiceArea/${ServiceAreaID}/Alerts/${AlertID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Work Order Alert Object.

Include Page

_Default Response Object Only

Panel

borderColor	#D3D3D3

Bulk Insert or Update the details of specific Work Order Alerts

This REST API will insert one or more new Work Order Alerts with the specified ID into the system, if the Work Order Alerts with the specified IDs do not already exist in the system.

If, however, the Work Order Alerts with the specified IDs do already exist in the system, then this REST API will update (i.e. replace) the already existing Work Order Alerts with the specified IDs with the details of the Work Order Alerts supplied in the HTTP Request Body.

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

POST /seiapi/v3/WorkOrder/Alerts

HTTP Request Body

The HTTP request body must be a JSON array of one or more Work Order Alert Object definitions.

Code Block

language	js
firstline	1
title	JSON Format
linenumbers	true
collapse	true

{
	"Alerts": [{
			// Work Order Alert Object
		},
		{
			// Work Order Alert Object
		}
	]
}

HTTP Response

On success the API will return a response code of 200.

_Default Response Object Only

HTTP Response

On success the API will return a response code of 200.

Panel

borderColor	#D3D3D3

Bulk Insert or Update the details of specific Work Order Alerts for a Service Area

This REST API will insert one or more new Work Order Alerts with the specified ID into the system for a Service Area, if the Work Order Alerts with the specified IDs do not already exist in the system. The Service Area with the specified ID must already exist in the system.

If, however, the Work Order Alerts with the specified IDs do already exist in the system, then this REST API will update (i.e. replace) the already existing Work Order Alerts with the specified IDs with the details of the Work Order Alerts supplied in the HTTP Request Body.

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

POST /seiapi/v3/WorkOrder/ServiceArea/${ServiceAreaID}/Alerts

HTTP Request Body

The HTTP request body must be a JSON array of one or more REST Object Definitions Work Order Activity Related Objects Work Order Alert Object definitions.

Code Block

language	js
firstline	1
title	JSON Format	firstline	1
linenumbers	true
collapse	true

{
	"Alerts": [{
			// Work Order Alert Object
		},
		{
			// Work Order Alert Object
		}
	]
}

Include Page

_Default Response Object Only

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent work order alert.

Panel

borderColor	#D3D3D3

Delete a specific Work Order Alert

This REST API will delete a Work Order Alert with the specified ID from the system. The Work Order Alert with the specified ID must already exist in the system.

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

DELETE /seiapi/v3/WorkOrder/Alerts/${AlertID}

HTTP Request Body

This request does not require a request body.

Include Page

_Default Response Object Only

Versions Compared

Old Version 3

New Version Current

Key

Resource URL Summary

API Specific Parameters

API Specifics

Retrieve the details of a specific Work Order Alert

URL

HTTP Request Body

HTTP Response

Insert or Update the details of a specific Work Order Alert

URL

HTTP Request Body

HTTP Response

HTTP Response

Insert or Update the details of a specific Work Order Alert for a Service Area

URL

HTTP Request Body

Bulk Insert or Update the details of specific Work Order Alerts

URL

HTTP Request Body

HTTP Response

HTTP Response

Bulk Insert or Update the details of specific Work Order Alerts for a Service Area

URL

HTTP Request Body

HTTP Response

Delete a specific Work Order Alert

URL

HTTP Request Body

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Resource URL Summary

API Specific Parameters

API Specifics

Retrieve the details of a specific Work Order Alert

URL

HTTP Request Body

HTTP Response

Insert or Update the details of a specific Work Order Alert

URL

HTTP Request Body

HTTP Response

Insert or Update the details of a specific Work Order Alert for a Service Area

URL

HTTP Request Body

HTTP Response

Bulk Insert or Update the details of specific Work Order Alerts

URL

HTTP Request Body

HTTP Response

Bulk Insert or Update the details of specific Work Order Alerts for a Service Area

URL

HTTP Request Body

HTTP Response

Delete a specific Work Order Alert

URL

HTTP Request Body

HTTP Response