Skip to main content

TestPointResponse

Schema for test point response.

Provides both the legacy results array (unchanged for backward compatibility) and the new matched_geofences array with enhanced group information.

point objectrequired

GeoJSON Point geometry schema

typeType (string)required

Possible values: Value must match regular expression ^Point$

coordinatesnumber[]required

Possible values: >= 2, <= 3

inside_geofencesInside Geofences (integer)required
total_geofencesTotal Geofences (integer)required
results object[]required
  • Array [
    • geofence_idGeofence Id (string)required
    geofence_nameGeofence Name (string)required
    is_insideIs Inside (boolean)required
    distance_meters object
    anyOf
    number
  • ]
    • matched_geofences object[]

    Geofences containing the test point, with group info. Ordered by distance_meters ASC, then geofence_id ASC.

  • Array [
    • geofence_idGeofence Id (string)required
    geofence_nameGeofence Name (string)required
    group_id object
    anyOf
    string
    group_name object
    anyOf
    string
    distance_meters object

    Distance from point to geofence edge in meters (0 if inside)

    anyOf
    number
  • ]
    • request_metadata object

    Client data echoed back unchanged from request.

    anyOf
    object
    TestPointResponse
    {
      "inside_geofences": 1,
      "matched_geofences": [
        {
          "distance_meters": 0,
          "geofence_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "geofence_name": "Warehouse Zone A",
          "group_id": "g1h2i3j4-k5l6-7890-mnop-qr1234567890",
          "group_name": "NYC Warehouses"
        }
      ],
      "point": {
        "coordinates": [
          -74.006,
          40.7128
        ],
        "type": "Point"
      },
      "request_metadata": {
        "correlation_id": "req-abc-123"
      },
      "results": [
        {
          "distance_meters": 0,
          "geofence_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "geofence_name": "Warehouse Zone A",
          "is_inside": true
        },
        {
          "distance_meters": 152.7,
          "geofence_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          "geofence_name": "Delivery Area",
          "is_inside": false
        }
      ],
      "total_geofences": 3
    }