Document toolboxDocument toolbox

Work Order Export API

Owned by Andrew Hill (Deactivated)
Last updated: Oct 03, 2024 by Jason Andrew
2 min read

3.0.0

The Work Order export API returns a collection of work order transactions as they are being updated by the technician. As the technician works on a work order, multiple status updates will be uploaded as separate transactions. 

On this page:

Related pages:

Resource URL Summary

Return a collection of updates made to Work Order Objects

GET /seiapi/v3/export/WorkOrder?rowver=${rowverValue}&limit=${limitValue}

API Specific Parameters

ParameterDescription
${rowverValue}Specifies the starting point where objects should be returned from. The first object returned will be the next object after the specified rowver.
${limitValue}Specifies the maximum number of objects to be returned.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Return a collection of updates made to Work Order Objects

This REST API will return a collection of updates made to Work Order Objects.

URL

GET /seiapi/v3/export/WorkOrder?rowver=${rowverValue}&limit=${limitValue}

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 zero of more Work Order Objects.

JSON Format 
{
    "rowver" : "",
    "rows" : [
        {
     		"rowver" : "",
			"WorkOrder" : {
               // Work Order JSON object properties
           }
        }
    ]
}

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