Document toolboxDocument toolbox

Work Order Estimate REST API

3.18.01

The Work Order Estimate REST API is used to retrieve work order estimate PDFs from S3 for a specified work order.

On this page:

Related pages:

Resource URL Summary

Retrieve the details of the latest Work Order Estimate for a specific Work Order

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Estimate

Retrieve a list of all Work Order Estimates for a specific Work Order

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Estimates

Retrieve the details of a specific Work Order Estimate for a specific Work Order

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Estimate/${FileName}

API Specific Parameters

ParameterDescription
${FileName}

Identifies the Work Order Estimate file name.

File name format is: Estimate.<yyyyMMdd>.<HHmmss>.pdf

ParameterDescription
yyyyMMddDate format
HHmmssTime format

${WorkOrderNum}

Identifies the Work Order Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.



API Specifics

Retrieve the details of the latest Work Order Estimate for a specific Work Order

This REST API will return the latest Work Order Estimate for the Work Order with the specified ID. The Work Order with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Estimate

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 the actual estimate PDF as an attachment.

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

Retrieve a list of all Work Order Estimates for a specific Work Order

This REST API will return a list of all valid Work Order Estimates for the Work Order with the specified ID. The Work Order with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Estimates

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 Estimates Object.

JSON Format
{
	"Estimates": [{
		"Name": "",
		"LastModifiedDate": ""
	}]
}

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

Retrieve the details of a specific Work Order Estimate for a specific Work Order

This REST API will return the Work Order Estimate with the specified file name for the Work Order with the specified ID. Both the Work Order with the specified ID and the Work Order Estimate with the specified file name must already exist in the system.

URL

GET /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/Estimate/${FileName}

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 the actual estimate PDF as an attachment.

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