Resource URL Summary
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Retrieve a Photograph for a specific Work Order GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Photos/${PhotoID} Attach Photographs to a specific Work Order POST /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Photos/ Delete a Photograph for a specific Work Order DELETE /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Photos/${PhotoID} Bulk Delete Photographs for a specific Work Order
|
API Specific Parameters
Parameter | Description |
---|---|
${PhotoID} | Identifies the ID of the photo to be accessed. |
| Identifies the |
Work Order Object. |
Include Page | ||||
---|---|---|---|---|
|
API Specifics
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Retrieve a Photograph for a specific Work OrderThis REST API will return the binary image data (with appropriate mime type HTTP header set) for the Photograph with the specified ID, for the Work Order with the specified ID. The Photograph with the specified ID and the Work Order with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP Response BodyOn success, an HTTP response code of 200 will be returned, and the response body will contain the the binary data for the Photograph.
|
Panel | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Attach Photographs to a specific Work OrderThis REST API will associate one or more Photographs to the Work Order with specified ID. The Work Order with the specified ID must already exist in the system. The REST API will store each Photograph as a jpeg file in the storage service. In addition, the Work Order object with specified ID will be updated to contain a reference to the Photograph(s) in the The This REST API requires that the URL
HTTP Request BodyThis request does not require a request body. HTTP Response BodyOn success, an HTTP response code of 201 will be returned, and the response body will contain a collection of objects. Each object will contain a file name for the Photograph.
|
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Delete a Photograph for a specific Work OrderThis REST API will delete a Photograph with the specified ID, for the Work Order with the specified ID, from the system. The Photograph with the specified ID and the Work Order with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body.
|
Panel | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
Bulk Delete Photographs for a specific Work OrderThis REST API will delete Photographs with the specified IDs, for the Work Order with the specified ID, from the system. The Photographs with the specified IDs and the Work Order with the specified ID must already exist in the system. URL
HTTP Request BodyThe HTTP request body must contain a a JSON array of Photograph IDs to be deleted.
|