Delete a waypoint by ID

DELETE 
/waypoints/:waypointId

The Delete Waypoint request allows you to remove a waypoint from the Map. This request takes in the waypoint's unique ID as a parameter, and will permanently delete the waypoint.

However, it's important to exercise caution when using this request, as it will permanently delete the waypoint, the Missions in which this Waypoint was used will be disabled. User can't be able to Initiate that particular Mission. Needs to update the Mission Tasks, in which this waypoint was used.

Request

Path Parameters

waypointId stringrequired

The ID of the waypoint to retrieve, update or delete

Responses

200

Waypoint deleted

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

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