Gateway GRPC

List Geofence Subscriptions

get/v2/organisations/{organisation_id}/geofence/subscriptions

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

Query parameters

limitnumber

Example:10

Number of items per page

pagenumber

Example:1

Page number

subscription_idstring

Example:019c233d-09df-762c-8db1-9f9015814a9e

Filter by subscription ID

geofence_boundary_type0 | 1 | 2 | 3 | 4

Example:1

Filter by geofence boundary type

geofence_categorystring

Example:School Transport

Filter by geofence category

Response

List of Geofence Subscriptions

Example response

{
  "subscriptions": [
    {
      "subscription_id": "019c233d-09df-762c-8db1-9f9015814a9e",
      "geofence_name": "Warehouse Perimeter",
      "organisation_id": "019c229e-343b-7c79-bfcc-a4b58de5fee4",
      "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"
      ],
      "status": "ENABLED",
      "boundary_id": "019c233d-09df-762c-8db1-9f9015814a9e",
      "frequency": {
        "day": [
          0,
          1,
          2,
          3,
          4,
          5,
          6
        ],
        "start_time": "00:00:00",
        "end_time": "23:59:59"
      },
      "boundary_details": {
        "boundary_type": "RADIAL",
        "boundary_details": {
          "radius_meters": "5000"
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "has_next": true
  }
}

Changes

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