Platform geofence

Geofence zones that give GPS positions their meaning.

Part of Platform in the register catalog.

Register ID

platform_geofenceUse this name to ask for the register. The API calls it a shelf ID.

Each record is

A stateThe current value of something, replaced when it changes.

Status

PlannedDefined ahead of the connector that will fill it.

Data

PublicShared, from public sources such as procurement portals.

Version

v1Current version.

Download JSON Schema

Connectors

Connected today

Demiton keeps this register current from these systems now.

No system fills this register yet.

On the roadmap

Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.

None planned yet.

Fields

9 fields: 3 required, 6 optional.

Required

Every record carries these fields.

geofence_idText

The source's own geofence id.

nameText

The geofence's name.

geometryGroup of fields

The zone's boundary.

Optional

Present when the source system records them.

zone_typesList

The kinds of place the zone is, e.g. customer site or depot.

radialTrue or false

Whether the zone is a circle around a point rather than a drawn boundary.

active_fromDate and timeISO 8601, with time zone

When the zone takes effect.

active_toDate and timeISO 8601, with time zone

When the zone stops applying.

external_referenceText

An id from another system the zone corresponds to.

must_identify_stopsTrue or false

Whether stops inside the zone are identified.

Use this contract

The contract is a standard JSON Schema (draft 2020-12) document, so any JSON Schema validator can check a record against it. Keywords starting with x-demiton- add Demiton's own meaning, such as units and requiredness, and validators ignore them.

Schema URL

https://docs.demiton.io/registers/platform_geofence/v1.json

Show the full JSON Schema

Loading the schema…