close anchor

Geo

The geo data object.

Data Fields

Field Type Description
id string The UUID of the geo data object for which data is being provided.
layer object The preferred default geo layer identified with this geo data object.
point string The default geographic point location for 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 for this geo data object.
json string The geo feature(s) in this geo data object, delivered as either a geometry- or feature-type geojson collection. If feature-type geojson is delivered, individual geo feature properties will be included therein, on which further information is provided in the table below.
features array The geo feature(s) in this geo data object, provided individually as geo feature object(s). If the json provided for the geo data object is feature-type geojson, this property will not be included.

JSON Geo Feature Properties

If the json provided for the geo data object is feature-type geojson, individual geo feature properties therein will include:

Key Description
_id The UUID of the geo feature.
_text The label, or name, identified with this geo feature, provided in the endpoint transaction or fallback locale (if plural, this will be delivered individually for each locale in a property with this key followed by the locale identifier (being of those provided by the /locales endpoint) prefixed by '_', i.e., Latin text being provided in '_text_la').
_type_id The UUID of the geo feature type identified with this geo feature.
_type_name The name of the geo feature type identified with this geo feature, provided in the endpoint transaction or fallback locale (if plural, this will be delivered individually for each locale in a property with this key followed by the locale identifier (being of those provided by the /locales endpoint) prefixed by '_', i.e., Latin text being provided in '_type_name_la').
_type_color The hex triplet identified with the geo feature type. This provides for an expression UI to present geo features using this value if desired.
_type_data If defined, the entity-attribute-value data identified with the geo feature type will be delivered in a property with this key followed by that of the value in question prefixed by '_', i.e., '_type_data_key'.

If defined, the entity-attribute-value data identified with this geo feature will be delivered in a top-level property with the key indicated for each value, too.

The below is an example of the geojson feature properties delivered with entity-attribute-value data included for both the geo feature and the geo feature type identified with it:

{
    "_id": "f3f1f9ae-ef85-45ee-887f-1c72153591b2",
    "_text": "Info: geo feature data point",
    "_type_id": "030b8371-22a3-4c9a-9df2-ceb81525d88a",
    "_type_name": "Point",
    "_type_color": "19180e",
    "_type_data_key": "Info: 'key' value in _geo feature type_ eav data",
    "key": "Info: 'key' value in _geo feature_ eav data"
}
Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*