Skip to content

Get areas

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

Get areas for given area IDs

The request to get areas by their unique identifiers

Media typeapplication/json
Get areas

The request to get areas by their unique identifiers

object
ids
required
Area IDs

The unique identifiers of the areas to list

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

A successful response.

Media typeapplication/json
Get areas response

The response containing the areas

object
areas
Areas

The list of areas

Array<object>
Messages for Area
object
id
Area ID

The area unique identifier. If not provided, a new area will be created.

string
name
Name

The name of the area

string
>= 1 characters <= 255 characters
tags
Tags

The tags associated with the area

Array<string>
geometry_ids
Geometry IDs

The unique identifiers of the geometries associated with the area

Array<string>
created_at
Created At

The date and time when the area was created

string format: date-time
updated_at
Updated At

The date and time when the area was last updated

string format: date-time
Example
{
"areas": [
{
"id": "63e2d42a27ad5f2b345ca123",
"name": "Area 1",
"tags": [
"tag1",
"tag2"
],
"geometry_ids": [
"63e2d42a27ad5f2b345ca123",
"63e2d42a27ad5f2b345ca124"
],
"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"
}
]
}