Skip to content

Get area geometries

POST
/geo/geometries
curl --request POST \
--url https://portal.staging.arago-tech.com/geo/geometries \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "ids": [ "63e2d42a27ad5f2b345ca123", "63e2d42a27ad5f2b345ca124" ] }'

Get area geometries for given area geometry IDs

The request to get area geometries by their unique identifiers

Media typeapplication/json
Get area geometries

The request to get area geometries by their unique identifiers

object
ids
required
Geometry IDs

The unique identifiers of the geometries to list

Array<string>
>= 1 items <= 3000 items
Example
[
"63e2d42a27ad5f2b345ca123",
"63e2d42a27ad5f2b345ca124"
]

A successful response.

Media typeapplication/json
Get area geometries response

The response containing the area geometries

object
area_geometries
Area Geometries

The list of area geometries

Array<object>
object
id
Geometry ID

The geometry unique identifier.

string
area_id
Area ID

The area unique identifier

string
geometry
Geometry

The geometry of the GeoJSON feature. Accepts Polygon or MultiPolygon types.

object
properties
Properties

The properties of the GeoJSON feature

object
key
additional properties
created_at
Created At

The date and time when the geometry was created

string format: date-time
updated_at
Updated At

The date and time when the geometry was last updated

string format: date-time
Example
{
"area_geometries": [
{
"id": "63e2d42a27ad5f2b345ca123",
"area_id": "63e2d42a27ad5f2b345ca123",
"geometry": {
"coordinates": [
[
[
30,
10
],
[
40,
40
],
[
20,
40
],
[
10,
20
],
[
30,
10
]
]
],
"type": "Polygon"
},
"properties": {
"name": "Area 1"
},
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z"
}
]
}

Bad request

Media typeapplication/json
object
Example
{
"error": {
"code": "BAD_REQUEST",
"details": [
{
"code": "MAX_ITEMS",
"field": "line_items",
"message": "value must contain no more than 3000 item(s)",
"params": {
"max": "3000"
}
}
],
"message": "Bad request"
}
}

Unauthorized

Media typeapplication/json
object
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}