close anchor

Element Geo Layers

To post an element geo layer:

POST /element/geo/layers

This endpoint provides for identifying a known geo layer with a geo-type element, to do which log in a user with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description
id string The UUID of the element to which this geo layer is being posted.
geo object This is an object with a layer property, the value of which is the UUID of the geo layer to be identified with the element in question. If the geo layer does not yet exist, first post it to the /geo/layers endpoint.

The data object provided by this endpoint is the element this geo layer is now identified with.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_element_type The element is of the wrong type to be identified with geo layers.
invalid_geo_layer The geo layer does not exist or is not provided.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update element geo layers:

PUT /element/geo/layers

This endpoint provides for updating the geo layer(s) identified with an element, to do which log in a user with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description
id string The UUID of the element for which to update geo layer(s).
geo object This is an object with a layers property, being a one-dimensional indexed array, in which each value is the UUID of an individual geo layer. The order in which each layer is provided determines its position as identified with the element in question.

The data object provided by this endpoint is the element for which geo layer information is now updated.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_element_type The element is of the wrong type to be identified with geo layers.
invalid_geo_layer The geo layer does not exist or is not provided.

If an error is not described on this page, the platform-wide error table provides further information.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*