Portal Login

GET requests

Interacting with Verilocation's GET methods

Pre-requisites

  • Pre-requisites: Authenticated and received an authentication Bearer token to submit with requests

Verilocation GET Requests

Verilocation provides access to GET endpoints that span across multiple data sources.

Each data source exposes multiple endpoints. Some endpoints do not require any path or query parameters, while others may require them to function correctly.

Below, we will explain how to make GET requests using OpenAPI, covering both parameterised and non-parameterised calls, and provide examples to help developers integrate with our API effectively.

Making a request

GET requests to Verilocation's API are made to the base URL https://api.verilocation.com using an HTTP request client.

To access the API, the client must set the Authorization header to Bearer your_returned_token.

If no parameters are included in the request, the API will return all available objects for the account associated with the provided token e.g.

.../public/v1/drivers endpoint will return all available Driver object models

GETs All Drivers for the Account

get

Accepts: - Path Parameters: • No path parameters required - Query Parameters: • No query parameters required

Returns: - All Driver Records for the Account

Responses
200
Query completed
get
GET /public/v1/drivers HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "mobile": "text",
    "status": 0,
    "username": "text",
    "password": "text",
    "email": "text",
    "buttonId": "text"
  }
]

Requesting with Path Parameters

Each Data source e.g. /drivers extends using path parameters to access either

  • different models associated with the Data source e.g. .../public/v1/drivers/assignments will return all Driver -> Vehicle mapping objects

GETs All VehicleDriverMapping Records for Account

get

Accepts: - Path Parameters: • No path parameters required - Query Parameters: • No query parameters required

Returns: - All VehicleDriverMapping Records for the Account

Responses
200
Query completed
get
GET /public/v1/drivers/assignments HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "vehicleId": 1,
    "driverId": 1,
    "startUtc": "2025-07-28T19:25:09.718Z",
    "endUtc": "2025-07-28T19:25:09.718Z",
    "assignmentSource": 0
  }
]

  • filtered results based on a variable path parameter e.g. .../public/v1/drivers/{driverId} will return a single Driver object model that maps to the provided {driverId}

GETs single Driver Record by Driver Id

get

Accepts: - Path Parameters: • {driverId} as an integer - Query Parameters: • No query parameters required

Returns: - Driver Record WHERE Driver.Id == {driverId}

Path parameters
driverIdinteger · int32Required

Driver Id

Responses
200
Query completed
get
GET /public/v1/drivers/{driverId} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "name": "text",
  "mobile": "text",
  "status": 0,
  "username": "text",
  "password": "text",
  "email": "text",
  "buttonId": "text"
}

Requesting with Query Parameters

Many of the endpoints in Verilocation's API use query parameters to further define the filtering of returned models.

Typically, the query parameters are used to refine the returned data by timeframe, with dates being the most commonly used parameter.

Please note that all dates included in API calls must be submitted in ISO8601 format:

YYYY-MM-DD'T'hh:mm:ss'Z',

where T is the time delimiter and Z denotes the submission in universal time.

This format is required to ensure consistency and accuracy in the processing of dates by our API

For example, a call to /public/v1/geofenceVisits requires the following query parameters:

  • startDate

  • endDate

GETs All GeofenceVisits for Account by timeframe

get

Accepts: - Path Parameters: • No Path Parameters required - Query Parameters: • startDate as a DateTime • endDate as a DateTime - DateTime for Start and End DateTimes are required in ISO 8601 format: yyyy-mm-ddThh:mm:ss.sssZ

Returns: - All GeofenceVisit Records FOR time period startDate to endDate

Query parameters
StartDatestring · date-timeOptional
EndDatestring · date-timeOptional
Startstring · date-timeOptional
Endstring · date-timeOptional
Responses
200
Query completed
get
GET /public/v1/geofenceVisits HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "geofenceId": 1,
    "vehicleId": 1,
    "startPlotId": 1,
    "endPlotId": 1,
    "startUtc": "2025-07-28T19:25:09.718Z",
    "endUtc": "2025-07-28T19:25:09.718Z"
  }
]

This will return records that were created during the resulting timeframe. Here's an example of the full API call:

https://api.verilocation.com/public/v1/geofenceVisits?startDate=2023-02-24T09:00:00Z&endDate=2023-02-24T17:00:00Z

This API call would return all GeofenceVisit models for February 24th, 2023 from 9am to 5pm UTC.

PreviousAuthenticationNextPOST requests

Last updated