Get a restricted zone by ID

GET 
/v1/restricted-zones/:id

Retrieve a single restricted zone by its ID

Request

Path Parameters

id stringrequired

Restricted zone ID

Responses

200

Restricted zone found successfully

application/json

Schema

Schema

_id stringrequired

The ID of the restricted zone

zoneName stringrequired

The name of the restricted zone

geo objectrequired

type stringrequired

coordinates number[]required

Array of rings for the polygon. Each ring is an array of [longitude, latitude] pairs. The first and last point must be the same.

activate booleanrequired

Whether the restricted zone is active

createdDate date-timerequired

The created date of the restricted zone

latestUpdate date-timerequired

The latest update date of the restricted zone

Example (from schema)

{
  "_id": "672d07188234567890123456",
  "zoneName": "Restricted Zone 1",
  "geo": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.4194,
          37.7749
        ],
        [
          -122.4094,
          37.7749
        ],
        [
          -122.4094,
          37.7849
        ],
        [
          -122.4194,
          37.7849
        ],
        [
          -122.4194,
          37.7749
        ]
      ]
    ]
  },
  "activate": true,
  "createdDate": "2025-01-01T00:00:00.000Z",
  "latestUpdate": "2025-01-01T00:00:00.000Z"
}

404

Restricted zone not found

Loading...