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 67 Next »




3.34.0

The Work Order Estimate History REST API manages work order estimates in the system. This API provides a full history of estimates created for a specific work order or a customer site. Work Order Estimate is a document specifying the approximate cost of the job. The Work Order uses Estimate as a baseline statement for how much job is likely to cost and effort involved.

On this page:

Related pages:

Resource URL Summary


Retrieve the Work Order Estimate History for a specific Work Order

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

Bulk Insert or Update the details of Work Order Estimate History for a specific Work Order

PUT /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/EstimateHistory

Find the details of Work Order Estimate History for a specific Account and Account Location

POST /seiapi/v3/trans/Account/${AccountNum}/Location/${LocationID}/EstimateHistory

Remove Work Order Estimate History for a specific Work Order

DELETE /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/EstimateHistory


API Specific Parameters

ParameterDescription
${AccountNum}Identifies the REST Object Definitions Account Location Related Objects Account Object.
${LocationID}Identifies the REST Object Definitions Account Location Related Objects Account Location Object.

${WorkOrderNum}

Identifies the REST Object Definitions Work Order Activity Related Objects 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/${EstimateID}

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 collection of Work Order Estimate Objects.

HTTP Response Body
// A collection of one or more Work Order Estimate History objects.
[
    {
        // Work Order Estimate History Object
    },
    {
        // Work Order Estimate History Object
    },
    {
        // etc., as required
    }
]

Bulk Insert or Update the details of Work Order Estimate History for a specific Work Order

This REST API will insert new Estimate History for a specific Work Order into the system, if the Estimate History do not already exist in the system.

If, however, the Estimate History for a specific Work Order do already exist in the system, then this REST API will update (i.e. replace) the already existing Estimate History with the details of the Estimate History supplied in the HTTP Request Body.

URL

PUT /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/EstimateHistory

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 Estimate Object definitions.

HTTP Response Body
// A collection of one or more Work Order Estimate History objects.
[
    {
        // Work Order Estimate History Object
    },
    {
        // Work Order Estimate History Object
    },
    {
        // etc., as required
    }
]

HTTP Response

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


Find the details of Work Order Estimate History for a specific Account and Account Location

This REST API provides the technician with the ability to retrieve zero or more Work Order Estimates based on a specified account and account location through a 3rd party external system.

Before the Account Location Work Order Estimate History API can be used for a given entity, it will be necessary to use the REST Configuration REST APIs Entity System Configuration REST API to update the entity's REST Object Definitions Configuration Related Objects Entity System Configuration Object and configure the RestApi.EstimateHistory property, to define the REST Endpoint URI of an API that implements the Account Location Work Order Estimate History REST API Interface.

URL

POST /seiapi/v3/trans/Account/${AccountNum}/Location/${LocationID}/EstimateHistory

HTTP Request Body

The HTTP request body must contain a valid Account Location Work Order Estimate History Object.

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a collection of Work Order Estimate Objects.

HTTP Response Body
// A collection of one or more Work Order Estimate History objects.
[
    {
        // Work Order Estimate History Object
    },
    {
        // Work Order Estimate History Object
    },
    {
        // etc., as required
    }
]

Remove Work Order Estimate History for a specific Work Order

This REST API will delete Work Order Estimate History for a specific Work Order from the system. The Work Order with the specified ID must already exist in the system.

URL

DELETE /seiapi/v3/trans/WorkOrder/${WorkOrderNum}/EstimateHistory

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