Skip to content

Upsert area

PUT
/geo/areas
curl --request PUT \
--url https://gateway.staging.arago-tech.com/geo/areas \
--header 'Content-Type: application/json' \
--data '{ "id": "63e2d42a27ad5f2b345ca123", "tags": [ "tag1", "tag2" ], "name": "Area 1", "geo_json": { "coordinates": [ [ [ 30, 10 ], [ 40, 40 ], [ 20, 40 ], [ 10, 20 ], [ 30, 10 ] ] ], "type": "Polygon" } }'

Creates or updates a geo area

The request to upsert an area

Media typeapplication/json
Upsert area

The request to upsert an area

object
id
Area ID

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

string
Example
63e2d42a27ad5f2b345ca123
tags
Tags

The tags associated with the area (max 10 items, each tag must be between 3 and 255 characters). Each tag must not contain only whitespace (NOT_BLANK). Tags are not trimmed.

Array<string>
Example
[
"tag1",
"tag2"
]
name
required
Name

The name of the area. Must not contain only whitespace (NOT_BLANK). Length is checked before surrounding whitespace is trimmed on write; the response returns the stored name.

string
>= 1 characters <= 255 characters
Example
Area 1
geo_json
required
GeoJSON

The GeoJSON representation of the area. The total area must be at least the size of an S2 cell at level 10 (approximately 48 km² minimum).

object
type
Type

The GeoJSON object type

string
Example
FeatureCollection
features
Features

The list of GeoJSON features

Array<object>
>= 1 items <= 300 items
GeoJSON Feature

A GeoJSON feature object

object
type
required
Type

The GeoJSON feature type

string
Example
Feature
properties
required
Properties

The properties of the GeoJSON feature

object
key
additional properties
Example
{
"name": "Area 1"
}
bbox
Bounding Box

The bounding box of the GeoJSON feature

Array<number>
Example
[
100,
0,
105,
1
]
geometry
required
Geometry

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

object
Example
{
"coordinates": [
[
[
30,
10
],
[
40,
40
],
[
20,
40
],
[
10,
20
],
[
30,
10
]
]
],
"type": "Polygon"
}
bbox
Bounding Box

The bounding box of the GeoJSON object

Array<number>
Example
[
100,
0,
105,
1
]
Example
{
"coordinates": [
[
[
30,
10
],
[
40,
40
],
[
20,
40
],
[
10,
20
],
[
30,
10
]
]
],
"type": "Polygon"
}

A successful response.

Media typeapplication/json
Upsert area response

The response containing the upserted area

object
area
Geo
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
{
"area": {
"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": "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"
}
]
}