Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

3.19.0 3.19.1

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. 

On this page:

Related pages:

Resource URL Summary

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}

Bulk Insert or Update the details of specific Work Order Alerts

POST /seiapi/v3/WorkOrder/Alerts

Delete a specific Work Order Alert

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

API Specific Parameters

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

 

API Specifics

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

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.

JSON Format 
{
   "AlertID": "",
   "AssetAge": {
      "Start": 12,
      "End": 35
   },
   "AssetType": "",
   "ConcessionID": "",
   "Deleted": false,
   "Extensions": {
      "FactoryProgCode": ""
   },
   "FixedCharges": [
      {
         "ProdNum": "",
         "RefCode": ""
      }
   ],
   "InWarranty": true,
   "IsActive": false,
   "Message": "",
   "ModelNumPattern": "",
   "ModifiedUTC": "",
   "PartialServiceCodeMatch": false,
   "ProdNumPattern": "",
   "SerialNumPattern": "",
   "ServiceCodes": [
      [
         "",
         ""
      ],
      [
         "",
         ""
      ]
   ],
   "SetInWarranty": false,
   "TemplateID": "",
   "URL": ""
}

Otherwise, on error, the API returns the standard response object.

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

PUT /seiapi/v3/WorkOrder/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. 

HTTP Response

The API returns the standard response object on both success and error.

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

POST /seiapi/v3/WorkOrder/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.

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

HTTP Response

The API returns the standard response object on both success and error.

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

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

HTTP Request Body

This request does not require a request body. 

HTTP Response

The API returns the standard response object on both success and error.

  • No labels