close anchor

Geo

To get information on a geo data object:

GET /geo

Parameters

Param Type Description Optional
id string The UUID of the geo data object.
json string Indicate a preference of either geometry- or feature-type geojson to be delivered in the json property of the geo data object.

The data object provided by this endpoint is an individual geo data object.

To post a geo data object:

POST /geo

In order to post a geo data object, log in a user identified with the entry to which it is being posted (being the user who initially posted it, or a collaborator), or an editor (if permitted for the entry).

Parameters

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

Param Type Description Optional
content string The UUID of the content entry to be identified with this geo data object, being an entry in a content type identified with the element below.
element string The UUID of the geo-type element to be identified with this geo data object.
layer string The UUID of the geo layer to be identified as the default for this geo data object, being either one of those explicitly identified with and enabled for the element in question or, if the value of the user_geo_layer preference for that element is true, a user-input layer posted to the /geo/layers endpoint.
point string The default geographic point location of this geo data object, provided as a comma-delimited textual value indicating both longitude and latitude, in that order.
zoom integer The preferred default zoom level of this geo data object.

The data object provided by this endpoint is the geo data object inserted.

Errors

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

ID/Type Description
integer_not_provided The value provided for zoom is not an integer.
invalid_element_type The element is not of the proper element type (geo), or is not identified with the content being posted to.
invalid_geo_data_point The point is not a valid geographic location.
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 a geo data object:

PUT /geo

In order to edit or update a geo data object, log in a user identified with the entry (being the user who initially posted it, or a collaborator), or an editor (if permitted for the entry).

Parameters

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

Param Type Description Optional
id string The UUID of the geo data object.
layer string The UUID of the geo layer to be identified as the default for this geo data object, being either one of those explicitly identified with and enabled for the element in question or, if the value of the user_geo_layer preference for that element is true, a user-input layer posted to the /geo/layers endpoint.
point string The default geographic point location of this geo data object, provided as a comma-delimited textual value indicating both longitude and latitude, in that order.
zoom integer The preferred default zoom level of this geo data object.

The data object provided by this endpoint is the updated geo data object.

Errors

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

ID/Type Description
integer_not_provided The value provided for zoom is not an integer.
invalid_geo_data_point The point is not a valid geographic location.
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 input a batch of features to a geo data object:

PUT /geo

In order to input features to a geo data object, log in a user identified with the entry (being the user who initially posted it, or a collaborator), or an editor (if permitted for the entry).

Parameters

Param Type Description Optional
id string The UUID of the geo data object.
type object Indicate, for each geometry type in the json provided, the geo feature type to be identified with geo features of that kind. This is to be an object in which each property key is the geometry type in question (point, path, polygon) and its value is the UUID of the geo feature type to be used for it.
json string Include a geometry- or feature-type geojson collection depicting the geo features to be imported to this geo data object. If the latter, feature properties will be interpreted as entity-attribute-value data if not otherwise indicated by key, on which further information is provided in the table below.
delete boolean Indicate whether or not existing geo features ought to be deleted. If not provided, the default value of false will be inferred.

JSON Geo Feature Properties

If the json provided for the geo data object is feature-type geojson, individual geo feature properties therein will be interpreted as entity-attribute-value data if not otherwise indicated by key (if not in the table below, keys prefixed by '_' will be ignored):

Key Description
_type_id The UUID of the geo feature type to be identified with the geo feature.

The data object provided by this endpoint is the updated geo data object.

Errors

ID/Type Description
data_length_exceeded The geo data json provided exceeds the length indicated, in bytes (eg., '{total}/{limit}'). If not deleting existing geo features (indicated by the delete parameter), the {total} will include the feature-type geojson this endpoint would deliver. This input limitation is tentative and will potentially vary until further notice.
invalid_geo_data_feature_type The geo data json provided is of, or includes, an incorrect geometry type per the geo feature type indicated for it.
invalid_geo_data_json The geo data json is not valid geojson or includes geometry type(s) not enabled by the parent geo data object.
invalid_geo_data_path The geo data json provided includes an invalid path (this is often due to there being one, or too few, unique points included).
invalid_geo_data_polygon The geo data json describes an invalid polygon (this is often due to a polygon not ending at its begin point).
invalid_geo_feature_type The geo feature type indicated does not exist, is not identified with the element to which the geo data object is linked, or is not of the intended geometry type (point, path, polygon).
invalid_geo_json The json provided is not valid geojson.
invalid_geo_json_type The json provided is not either a geometry- or feature-type geojson collection.

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

To delete a geo data object:

DELETE /geo

In order to delete a geo data object, log in a user identified with the entry (being the user who initially posted it, or a collaborator), or an editor (if permitted for the entry).

Parameters

Param Type Description
id string The UUID of the geo data object to be deleted.

The data object provided by this endpoint is the deleted geo data object.

Errors

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

ID/Type Description
entity_in_use The geo data object was not deleted because it is presently in use, being that it includes geo feature(s) or is not empty.

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*