Quick Goal Waypoint

POST 
/robot/quickgoal/:waypointId

The Quick Goal Waypoint request allows you to send a quick goal to the robot. This request takes in the waypoint's unique ID as a parameter, and will send the Robot to the desired waypoint.

Request

Path Parameters

waypointId stringrequired

The ID of the waypoint to send the robot to.

Responses

200

Quick Goal sent

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Quick Goal sent"
}

Example

{
  "message": "Quick Goal sent"
}

400

Robot is not in Auto Mode, to perform this turn Robot to Autonomous mode.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Robot is not in Auto Mode, to perform this turn Robot to Autonomous mode."
}

Example

{
  "message": "Robot is not in Auto Mode, to perform this turn Robot to Autonomous mode."
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...