Check protected-areas overlap

Request

Accepts a JSON object with 'plot_ids' (array of strings) and/or 'geojson' (At least one of the two fields must be provided). Returns a single GeoJSON FeatureCollection with all results.

Access: this endpoint requires the PROTECTED_AREA_USER (or ADMIN) role; standard user tokens without that role receive 403 {"code":403,"message":"HTTP 403 Forbidden"}.

Security

BearerAuth

Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature

Bodyapplication/jsonrequired

plot_idsArray of strings

geojsonobject(GeoJson)

GeoJSON representation of the plot's geographical data

Example:

{
  "type": "FeatureCollection",
  "features": [
    { … }
  ]
}

POST

/protected-areas/checks

curl -i -X POST \
  https://api.open-atlas.com/_mock/openapi/protected-areas/checks \
  -H 'Authorization: Bearer <YOUR_JWT or vantage_live_ API key_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "plot_ids": [
      "b7e1c2d3-4f5a-6789-0abc-def123456789"
    ],
    "geojson": {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {},
          "geometry": {
            "coordinates": [
              [
                [
                  10.12345,
                  20.54321
                ],
                [
                  10.54321,
                  20.12345
                ],
                [
                  10.6789,
                  20.6789
                ],
                [
                  10.12345,
                  20.54321
                ]
              ]
            ],
            "type": "Polygon"
          }
        }
      ]
    }
  }'

Responses

GeoJSON FeatureCollection with protected area analysis results

Bodyapplication/json

typestringrequired

Example:"FeatureCollection"

featuresArray of objects(GeoJsonFeature)required

A list of GeoJson Features that this FeatureCollection is made of

Example:

[
  {
    "type": "Feature",
    "geometry": { … }
  }
]

Response

Protected Areas Analysis Result

{
  "type": "FeatureCollection",
  "features": [
    { … },
    { … }
  ]
}