v1

latestOpenAPI 3.0.0Apache 2.02026-08-063010285.3 KB

Geofence Collection

Create geofence collection

Create a geofence collection by providing fields named collection_name and entries. The geofence collection geometry may be one of Polygon or Circle.

post/v1/geofence-collection

Request body

collection_namestring required

Example request

{
  "collection_name": "collection_name",
  "entries": [
    {
      "GeofenceId": "geofence_id",
      "Geometry": {
        "Polygon": [
          [
            -84.94713408143345,
            43.38009085676791
          ],
          [
            -84.93943372033695,
            43.15714706629157
          ],
          [
            -84.60337504788632,
            43.169392182092594
          ],
          [
            -84.61029494482077,
            43.38746832635201
          ],
          [
            -84.94554425452868,
            43.37938877562664
          ]
        ]
      }
    }
  ]
}

Response

CreateGeofenceCollectionResponse

string required

Example response

"Geofence collection (collection_name) created successfully."