Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

5.19.2

an API for precise technician location tracking within ServicePortal. Users can access live location updates, visualize technician movement on a map, and receive notifications at key service milestones, improving both customer experience and operational efficiency. 

On this page:

Related pages:

Resource URL Summary

GET /up/v5/geolocation/workItem/${workItemId}

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specific Parameters

ParameterTypeRequired?Description

${workItemId}

string

Yes

WorkItemId.

API Specifics

URL

GET /up/v5/geolocation/workItem/${workItemId}

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "Update Request for Authorization" API response will be returned.

{
    "Id": "10864",
    "DateTime": "2024-01-18T12:04:43.426Z",
    "Lat": 53.4862886,
    "Lon": -2.3573066
}

Error

On error, a JSON-formatted version of the ServiceDispatch "Update Request for Authorization" API response will be returned. 

{
    "Success": false,
    "Code": 400,
    "Message": "No data found for WorkItemId: dc110123-1511",
    "Error": {
        "name": "BadRequest",
        "message": "No data found for WorkItemId: dc110123-1511",
        "code": 400,
        "className": "bad-request"
    }
}

Return Codes

In addition to the Standard Return Codes, and the ServiceDispatch Error codes, individual API calls made have unique codes found on their individual pages.

  • No labels