Versions Compared

Version Old Version 2 New Version Current
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title5.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.    


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specific Parameters

ParameterTypeRequired?Description

${workItemId}

string

Yes

WorkItemId.


API Specifics


Panel
borderColor#D3D3D3

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.

Code Block
languagejs
{
    "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. 

Code Block
languagejs
{
    "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.