Robot Webservice

Deploy robot

Deploy the robot to a mapped point at its location

post/api/robot/deploy

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/robot/deploy
  • 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

deviceUuidstring RUUID nullable

base 64 (url-safe) uuid string

navType'ROUTE' | 'PATROL' | 'WAYPOINT' | 'POSE'
patrolUuidstring RUUID nullable

base 64 (url-safe) uuid string

routeUuidstring RUUID nullable

base 64 (url-safe) uuid string

waypointUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "patrolUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorMsgstring nullable
routeRunUuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "routeRunUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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