Resource URL Summary
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Retrieve the details of a specific Work Order Alert GE 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 REST Object Definitions Account Location Related Objects Service Area Object. |
API Specifics
Panel | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
Retrieve the details of a specific Work Order AlertThis 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
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn 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.
|
Panel | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Insert or Update the details of a specific Work Order AlertThis 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
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Work Order Alert Object. HTTP ResponseOn success the API will return a response code of 200. |
Panel | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Insert or Update the details of a specific Work Order Alert for a Service AreaThis 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
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Work Order Alert Object. | _Default Response Object Only | _Default Response Object Only
Panel | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Bulk Insert or Update the details of specific Work Order AlertsThis 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
HTTP Request BodyThe 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.
HTTP ResponseOn success the API will return a response code of 200. |
Panel | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Bulk Insert or Update the details of specific Work Order Alerts for a Service AreaThis 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
HTTP Request BodyThe 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.
Include Page | | _Default Response Object Only | _Default Response Object Only
Panel | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Delete a specific Work Order AlertThis 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
HTTP Request BodyThis request does not require a request body. | _Default Response Object Only | _Default Response Object Only