close anchor

Geo Features

To get information on geo features:

GET /geo/features

Parameters

Param Type Description
id string The UUID of an individual geo feature on which to provide data.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of geo feature object(s).

To post a geo feature:

POST /geo/features

Parameters

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

Param Type Description Optional
geo object This is an object tree for which the value of the id property is to be the UUID of the geo data object to which this geo feature is being posted, and the feature :: type is an object for whose id property the value is the UUID of the geo feature type to be identified with this geo feature.
json string The geojson depiction of the physical location or geography to be embodied by this geo feature.
text string The label, or name, to be identified with this geo feature, provided in the endpoint transaction locale.

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

Errors

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

ID/Type Description
invalid_geo_data The geo data json was not included or describes a physical location that does not exist.
invalid_geo_data_feature_type The geo data json provided is of an incorrect geometry type per the geo feature type indicated.
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_object The parent geo data object was not indicated or does not exist.
invalid_geo_data_path The geo data json provided does not include a valid 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 was not provided or does not exist.
type_quota_exceeded The geo feature limit in effect for this geo feature type would be exceeded.

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

To edit or update an individual geo feature:

PUT /geo/features

This endpoint provides for updating a geo feature.

Parameters

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

Param Type Description Optional
id string The UUID of the geo feature being edited.
type string The UUID of the geo feature type to be identified with this geo feature.
json string The geojson depiction of the physical location or geography to be embodied by this feature.
text string The label, or name, to be identified with this feature, provided in the endpoint transaction locale.
attributes object The entity-attribute-value data to be identified with this entity (in order to provide for batch input via the /geo endpoint, keys prefixed by '_' will be ignored).

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

Errors

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

ID/Type Description
invalid_geo_data The geo data json included describes a physical location that does not exist.
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 does not include a valid 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 provided is not valid or does not exist.
type_quota_exceeded The geo feature limit in effect for this geo feature type would be exceeded.

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

To edit or update geo feature positions:

PUT /geo/features

This endpoint provides for updating the order in which to deliver features in a parent geo data object.

In order to update geo features, log in a user identified with the parent 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
id string The UUID of the parent geo data object.
features array Include a one-dimensional array in which each key is the UUID of an individual geo feature and its value is an integer declaring its position in the order it will be delivered.

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

To delete a geo feature:

DELETE /geo/features

In order to delete geo features, log in a user identified with the parent 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 feature to be deleted.

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

Errors

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

ID/Type Description
invalid_geo_data The geo feature quota in effect for this geo feature type would be ignored if this entry were deleted.

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*