Get a flat zone by ID

GET 
/v1/flat-zones/:id

Retrieve a single flat zone by its ID

Request

Path Parameters

id stringrequired

Flat zone ID

Responses

200

Flat zone found successfully

application/json

Schema

Schema

_id stringrequired

The ID of the flat zone

zoneName stringrequired

The name of the flat 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.

createdDate date-timerequired

The creation date of the flat zone

latestUpdate date-timerequired

The latest update date of the flat zone

Example (from schema)

{
  "_id": "672d07188234567890123456",
  "zoneName": "Flat 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
        ]
      ]
    ]
  },
  "createdDate": "2021-01-01",
  "latestUpdate": "2021-01-01"
}

404

Flat zone not found

Loading...