CAcautio
Gateway GRPC

Create Geofence Subscription

post/v2/organisations/{organisation_id}/geofence/subscription/create

Request

  • Base URL
    https://api.cautio.in (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

organisation_idstring required
Example:019aa01c-a1a9-7fae-961b-23845147892e

Organisation ID

Request body

geofence_namestring required

Geofence name

usagestring required

Usage context of geofence

categorystring required

Geofence category

eventsstring[] required

Events to subscribe for

statusnumber required

Status of the geofence subscription

Example request

{
  "geofence_name": "Warehouse Perimeter",
  "entity_ids": {
    "sub_organisation_ids": [
      "019c233d-09df-762c-8db1-9f9015814a9e"
    ],
    "vehicle_tags": [
      "019c233d-09df-74ce-b815-dc608e835585"
    ],
    "vehicle_ids": [
      "019c233d-09df-74ce-b815-dc608e835585"
    ]
  },
  "usage": "Tracking",
  "category": "Logistics",
  "events": [
    "ENTER",
    "EXIT",
    "CLOSE_PROXIMITY"
  ],
  "boundary_details": {
    "boundary_type": 1,
    "radial_boundary": {
      "center": {
        "latitude": 12.9716,
        "longitude": 77.5946
      },
      "radius_meters": 1000
    },
    "polygonal_boundary": {
      "vertices": [
        {
          "latitude": 12.915103971345061,
          "longitude": 77.54220495842674
        },
        {
          "latitude": 12.914346819728294,
          "longitude": 77.54323957801279
        },
        {
          "latitude": 12.915280204582459,
          "longitude": 77.54349404755573
        },
        {
          "latitude": 12.915639197828312,
          "longitude": 77.54304537757258
        },
        {
          "latitude": 12.915103971345061,
          "longitude": 77.54220495842674
        }
      ]
    },
    "route_boundary": {
      "route_points": [
        {
          "latitude": 12.915103971345061,
          "longitude": 77.54220495842674
        },
        {
          "latitude": 12.914346819728294,
          "longitude": 77.54323957801279
        },
        {
          "latitude": 12.915280204582459,
          "longitude": 77.54349404755573
        }
      ],
      "buffer_meters": 50
    }
  },
  "status": 1,
  "frequency": {
    "day": [
      0,
      1,
      2,
      3,
      4,
      5,
      6
    ],
    "start_time": "00:00:00",
    "end_time": "23:59:59"
  }
}

Response

Geofence Subscription created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.