Work Order TechNotes REST API
Resource URL Summary
Retrieve Tech Notes for a specific work order
GET
/seiapi/v3/trans/WorkOrder/${OrderNum}/TechNotes
Insert or Update Tech Notes for a specific work order
PUT
/se
iapi/v3/trans/WorkOrder/${OrderNum}/TechNotes
Delete Tech Notes for a specific work order
DELETE
Â
/seiapi/v3/trans/WorkOrder/${OrderNum}/TechNotes
API Specific Parameters
Parameter | Description |
---|---|
${OrderNum} | Identifies the Work Order TechNotes Object. |
Retrieve Tech Notes for a specific work order
This REST API will return the Tech Notes for the work order. The work order with specified ID must already exist in the system.
URL
GET /seiapi/v3/trans/WorkOrder/${OrderNum}/TechNotes
HTTP Request Body
This request does not require a request body.
HTTP Response Body
On success, an HTTP response code of 200 will be returned, and the response body will contain a Work Order TechNotes Object. Otherwise, on error, the response body will contain a descriptive reason for the error.Â
Insert or Update Tech Notes for a specific work order
This REST API will insert Tech Notes for a specific work order. The system will replace Tech Notes in case work order exists in the system. If Tech Notes collection was modified, the HTTP response code of 200 will be returned. Otherwise, on error, the appropriate HTTP response code will be returned along with details of the error in the response body.
URL
PUT /seiapi/v3/trans/WorkOrder/${OrderNum}/TechNotes
HTTP Request Body
The HTTP request body must contain a valid Work Order TechNotes Object.Â
HTTP Response Body
On success the API will return a response code of 200.
Delete Tech Notes for a specific work order
This REST API will delete Tech Notes for a specific work order from the system. The work order with specified ID must already exist in the system.
URL
DELETE /seiapi/v3/trans/WorkOrder/${OrderNum}/TechNotes
HTTP Request Body
This request does not require a request body.
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 TechNotes Object.