Robot Webservice

Get a route run by UUID

Retrieve a route run by its UUID.

post/api/robot/getRouteRun

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/robot/getRouteRun
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

routeRunUuidstring RUUID nullable required

base 64 (url-safe) uuid string

Example request

{
  "routeRunUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "routeRun": {
    "arrivedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "completedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "parentRouteRunUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "startedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.