Get a list of waypoints

GET 
/waypoints

The Get All Waypoints request allows users to retrieve a list of all the waypoints that are associated with the current active map in ANSCER ROBOT.

To use this request, you need to send a GET request to the API endpoint. ANSCER ANYA will then retrieve a list of all waypoints that are currently available in active Map and return them in the response body in JSON format.

Request

Responses

200

A list of waypoints

application/json

Schema

Schema

• Array [
_id uuid
name string

Possible values: >= 3 characters and <= 50 characters

category waypointTypes

Possible values: [normal, special, charging, home]

dockMarker number
coordinate object
position objectrequired
x doublerequired
y doublerequired
z doublerequired
orientation objectrequired
x doublerequired
y doublerequired
z doublerequired
w doublerequired
map object

_id uuid

name string

Possible values: >= 3 characters and <= 50 characters

properties object
createdBy object
The user who created this waypoint
_id string
name string
email email
updatedBy object
The user who last updated this waypoint
_id string
name string
email email
createdAt date-time

The date and time this waypoint was created

updatedAt date-time

The date and time this waypoint was last updated

• ]

Example (from schema)

[
  {
    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "category": "normal",
    "dockMarker": 0,
    "coordinate": {
      "position": {
        "x": 0,
        "y": 0,
        "z": 0
      },
      "orientation": {
        "x": 0,
        "y": 0,
        "z": 0,
        "w": 0
      }
    },
    "map": {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "properties": {},
    "createdBy": {
      "_id": "string",
      "name": "string",
      "email": "user@example.com"
    },
    "updatedBy": {
      "_id": "string",
      "name": "string",
      "email": "user@example.com"
    },
    "createdAt": "2024-12-03T13:26:27.466Z",
    "updatedAt": "2024-12-03T13:26:27.466Z"
  }
]

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."
}

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...