Skip to content

Send a Navigation Target

Send road-network coordinates to a specified robot as a navigation target.

  • Name: Send a navigation target
  • Description: Directs a robot to the specified coordinates.
  • Method: POST
  • Path: remoteApi/setPosToDog
  • Login required: No
  • Permission required: Yes

Note: The robot must be in remote-control mode. Select a point on the road network whenever possible. See List nodes for the available road-network nodes.


ParameterTypeRequiredExampleDescription
dogCodeStringYes001Robot code
edgeCodeStringYesEdge code
xStringYesx-coordinate
yStringYesy-coordinate
zStringNoz-coordinate

Example:

{
"dogCode": "001",
"edgeCode": "a001_3",
"x": -501.5144372913229,
"y": 1165.4871181800718,
"z": 0
}
FieldTypeExampleDescription
codeInteger200Status code
successBooleantrueWhether the request succeeded
msgStringsuccessResponse message

Example:

{
"success": true,
"code": 200,
"msg": "Operation succeeded",
"data": null
}
CodeDescription
400Invalid parameters
401Unauthorized
403Access denied
404Resource not found
500Internal server error