close anchor

Geo Feature Types

To get information on geo feature types:

GET /geo/feature/types

Parameters

Param Type Description Optional
id string The UUID of an individual geo feature type on which to provide data.
enabled boolean Indicate whether or not to filter geo feature types based on this property. Include a value of either true or false to indicate the geo feature types to be provided.
default boolean Indicate whether or not to filter geo feature types based on this property. Include a value of either true or false to indicate the geo feature types to be provided.
type string The geometry type by which to filter geo feature types, being a value of point, path, or polygon.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, id, name.

If plural locales indicated for the endpoint transaction and name is present in the list of field(s) to order by, querying will be performed in the initial locale (but data will be included for each).
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.

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

To post a geo feature type:

POST /geo/feature/types

In order to post a geo feature type, log in a user identified with owner-level privileges.

Parameters

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

Param Type Description Optional
type string The geometry type to be identified with geo features of this kind, being a value of either point, path, or polygon.
name string The name of the geo feature type, provided in the endpoint transaction locale.
color string The hex triplet to be identified with this geo feature type.
quantity array of integers The quantity of geo features of this kind to permit in a geo data object (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).
enabled boolean Indicate whether the geo feature type is to be enabled.

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

Errors

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

ID/Type Description
invalid_geo_feature_type_name The geo feature type name is empty or was not provided.
invalid_geo_type The geometry type is not valid.
invalid_hexadecimal The color provided is not a valid hex triplet.

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

To edit or update a geo feature type:

PUT /geo/feature/types

In order to edit or update a geo feature type, log in a user identified with owner-level privileges.

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 type being updated.
name string The name of the geo feature type, provided in the endpoint transaction locale.
color string The hex triplet to be identified with this geo feature type.
quantity array of integers The quantity of geo features of this kind to permit in a geo data object (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).
enabled boolean Indicate whether the geo feature type is to be enabled.
default boolean Indicate whether the geo feature type is to be the default of its kind (i.e., the geometry type identified with it, being either point, path, or polygon) for the project.
attributes object The entity-attribute-value data to be identified with this entity.

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

Errors

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

ID/Type Description
invalid_geo_feature_type The geo feature type does not exist.
invalid_geo_feature_type_name The geo feature type name is empty or was not provided.
invalid_hexadecimal The color provided is not a valid hex triplet.

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

To delete a geo feature type:

DELETE /geo/feature/types

In order to delete a geo feature type, log in a user identified with owner-level privileges.

Parameters

Param Type Description
id string The UUID of the geo feature type to be deleted.

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

Errors

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

ID/Type Description
geo_feature_type_not_empty The geo feature type is not empty and was therefore not 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*