Skip to content

Get area geometries

POST
/geo/geometries
curl --request POST \
--url https://gateway.staging.arago-tech.com/geo/geometries \
--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, as 24-character hexadecimal strings. The all-zero identifier 000000000000000000000000 is rejected.

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": "PATTERN",
"field": "username",
"message": "does not match regex pattern `^[a-zA-Z]*$`"
},
{
"code": "MIN_LEN",
"field": "username",
"message": "must be at least 3 characters",
"params": {
"min": "3"
}
}
],
"message": "Bad request"
}
}

Unauthorized

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

Forbidden

Media typeapplication/json
object
Example
{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
}
}

Not found

Media typeapplication/json
object
Example
{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL",
"details": [
{
"code": "INTERNAL",
"field": "line_items[0]",
"message": "Couldn't upsert line item"
},
{
"code": "INTERNAL",
"field": "line_items[380]",
"message": "Couldn't upsert line item"
}
],
"message": "Internal server error"
}
}

Gateway timeout

Media typeapplication/json
object
Example
{
"error": {
"code": "TIMEOUT",
"details": [
{
"code": "TIMEOUT",
"field": "request",
"message": "Request processing time exceeded deadline",
"params": {
"duration": "30s"
}
}
],
"message": "Gateway timeout"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field.

Protobuf APIs provide utilities to interact with Any values:

  • A ‘pack’ operation accepts a message and constructs a generic Any wrapper around it.
  • An ‘unpack’ operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url.
  • An ‘is’ operation decides whether an Any contains a message of the given type, i.e. whether it can ‘unpack’ that type.

The JSON format representation of an Any follows one of these cases:

  • For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL.
  • For types with special-cased JSON encodings (typically called ‘well-known’ types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value.

The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.

object
@type

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.

Example: type.googleapis.com/google.protobuf.StringValue

This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them.

The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests.

All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected.

In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}