Get a zone by ID

GET 
/zones/:zoneId

The Get Zone request allows you to retrieve information about a specific zone of the current map in ANSCER ROBOT. This request takes in the zone's unique ID as a parameter, and returns a JSON object containing information about the zone.

Request

Path Parameters

zoneId stringrequired

The ID of the zone to retrieve, update or delete

Responses

200

Zone details

application/json

Schema

Schema

_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)

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

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