CAcautio
Gateway GRPC

Get clustered vehicle markers for map viewport

post/v2/organisations/{organisation_id}/vehicles/in-bounds

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

entity_type0 | 1 required
state0 | 1 | 2 | 3 | 4

Request body

zoomnumber required
vehicle_idsstring[]

Vehicle IDs to filter by

organisationsOrganisationFilterDto[]

Organisations to filter by

Example request

{
  "viewport": {
    "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
      }
    ]
  },
  "vehicle_ids": [
    "019aa01c-a1a9-7fae-961b-23845147892e",
    "019aa01c-a1a9-7fae-961b-23845147892f"
  ],
  "organisations": [
    {
      "id": "019ba16d-d19b-7486-9b8c-fad000196564",
      "is_directly_assigned": true
    },
    {
      "id": "019c9910-c573-777c-a8ab-cd49769de4a0",
      "is_directly_assigned": false
    }
  ]
}

Response

Map markers retrieved successfully

Example response

{
  "data": {
    "items": [
      {
        "position": {
          "longitude": -122.4194,
          "latitude": 37.7749
        }
      }
    ]
  }
}

Changes

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