Get Active map and data

GET 
/maps/data

The Get Active map and data request allows unauthenticated/authenticated users to retrieve detailed information(waypoints, zones) about a specific map.

Request

Responses

200

Currently Active Map and data(Waypoints and Zones related to that map) object.

application/json

Schema

Schema

map object

_id uuid

name string

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

isActive boolean

properties object

origin object

position objectrequired

x doublerequired

y doublerequired

z doublerequired

orientation objectrequired

x doublerequired

y doublerequired

z doublerequired

w doublerequired

width double

height double

resolution double

previewUrl uri

createdBy object

The user who created this map

_id string

name string

email email

updatedBy object

The user who last updated this map

_id string

name string

email email

createdAt date-time

The date and time this user was created

updatedAt date-time

The date and time this user was last updated

waypoints object[]
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
]
zones object[]
Array [
_id uuid
name string
Possible values: >= 3 characters and <= 50 characters
category zoneTypes
Possible values: [restricted, warning, blink, buzzer, speed, no-plan]
isActive boolean
Default value: true
type string
Possible values: [Feature]
GeoJSON type of the zone, always Feature
geometry object
oneOf
GeoJSONPoint
type stringrequired
Possible values: [Point]
coordinates double[]required
GeoJSONLineString
type stringrequired
Possible values: [LineString]
coordinates array[]required
GeoJSONPolygon
type stringrequired
Possible values: [Polygon]
coordinates array[]required
map object
_id uuid
name string
Possible values: >= 3 characters and <= 50 characters
properties object
createdBy object
The user who created this zone
_id string
name string
email email
updatedBy object
The user who last updated this zone
_id string
name string
email email
createdAt date-time
The date and time this zone was created
updatedAt date-time
The date and time this zone was last updated
]

Example (from schema)

{
  "map": {
    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "isActive": true,
    "properties": {
      "origin": {
        "position": {
          "x": 0,
          "y": 0,
          "z": 0
        },
        "orientation": {
          "x": 0,
          "y": 0,
          "z": 0,
          "w": 0
        }
      },
      "width": 0,
      "height": 0,
      "resolution": 0,
      "previewUrl": "string"
    },
    "createdBy": {
      "_id": "string",
      "name": "string",
      "email": "user@example.com"
    },
    "updatedBy": {
      "_id": "string",
      "name": "string",
      "email": "user@example.com"
    },
    "createdAt": "2024-12-03T13:26:27.460Z",
    "updatedAt": "2024-12-03T13:26:27.460Z"
  },
  "waypoints": [
    {
      "_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.461Z",
      "updatedAt": "2024-12-03T13:26:27.461Z"
    }
  ],
  "zones": [
    {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "category": "restricted",
      "isActive": true,
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.989,
          40.735
        ]
      },
      "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.462Z",
      "updatedAt": "2024-12-03T13:26:27.462Z"
    }
  ]
}

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