Create a new waypoint

POST 
/waypoints

The Create Waypoint request allows you to create a new waypoint for the current active map in ANSCER Robot.

Request

application/json

Body

required

name stringrequired

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

A unique name of the waypoint

category waypointTypesrequired

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

dockMarker number

Dock marker number, this will be required if the waypoint type is charging or special.

properties object

Responses

200

Waypoint created

application/json

Schema

Schema

_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.476Z",
  "updatedAt": "2024-12-03T13:26:27.476Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    }
  ]
}

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

409

The Waypoint with given name already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "The Waypoint with given name already exists."
}

Example

{
  "message": "The Waypoint with given name already exists."
}

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