POST requests
Interacting with Verilocation's POST endpoints
Pre-requisites
Pre-requisites: Authenticated and received an authentication Bearer token to submit with requests
Verilocation POST Requests
POST RequestsVeriLocation has multiple POST endpoints that allow for data models to be created or updated via the v1API including
TMS route Plans
Creation and assignation of External References ( see External References)
When sending a POST request with data to the Verilocation system all data should be sent within the request body (with the exception of one ExternalReference endpoint.
Create Vs Update
In some cases the same endpoint is available to both Create and Update a data model.
If a model requires updating, the model can be retrieved, have the required fields updated and sent as a POST request along with the model 'Id' which is received.
If a model represents a new Object e.g. a New Geofence, then the model should not include an Id. This is assigned by the System and the field should be left off the model entirely
When sending a POST request for new data models, do not include the Id field. This will be assigned by the System and returned on success
When sending a POST request with updated data models, the original Id should be included in the model.
POST endpoints
Driver
The POST Drivers endpoint allows for new Driver models to be loaded into the system
POST /public/v1/drivers HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 118
{
"id": 1,
"name": "text",
"mobile": "text",
"status": 0,
"username": "text",
"password": "text",
"email": "text",
"buttonId": "text"
}Success
1Body Fields
{
"id": 0, // SHOULD ONLY BE INCLUDED ON UPDATE OF EXISTING DRIVER
"name": "string", // Required * May be passed with or instead of 'buttonId' field
"mobile": "string",
"status": 0, // Required
"username": "string", // Required
"password": "string", // Required
"email": "string",
"buttonId": "string" * May be passed with or instead of 'name' field
}The return will be the newly created Driver's Id.
Driver Assignments
2 separate endpoints exist for Driver Assignment. The first creates a vehicle assignment, and the second ends an assignment.
Creating Driver -> Vehicle Assignments
The POST endpoint for creating Driver Assignments allows for a relationship between a Driver and Vehicle to be assigned.
POST /public/v1/drivers/assignments/start HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 130
{
"id": 1,
"vehicleId": 1,
"driverId": 1,
"startUtc": "2025-07-28T19:36:17.265Z",
"endUtc": "2025-07-28T19:36:17.265Z",
"assignmentSource": 0
}Success
No content
Body Fields
{
"vehicleId": 0, // Required
"driverId": 0, // Required
"startUtc": "2023-02-28T11:07:13.394Z", // Required
}Ending Driver -> Vehicle Assignments
The POST endpoint for ending Driver assignments ends an association between a Driver and Vehicle
POST /public/v1/drivers/assignments/end HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 130
{
"id": 1,
"vehicleId": 1,
"driverId": 1,
"startUtc": "2025-07-28T19:36:17.265Z",
"endUtc": "2025-07-28T19:36:17.265Z",
"assignmentSource": 0
}Success
No content
Body Fields
{
"vehicleId": 0, // Required
"driverId": 0, // Required
"endUtc": "2023-02-28T11:34:19.797Z" // Required
}External References
External References allow VeriLocation Data models to be attributed with an External reference representing how integrating systems identify the Vehicle / Driver / Geofence.
Endpoints exist for GETs that allow models to then be retrieved using these External References.
Please see the External Reference section for guides on how to implement, utilise and mange these resources.
Geofences
The POST endpoint for Geofences allows for a new Geofence to be created or for existing Geofences to be updated.
Gets or sets Address Line 1
Gets or sets Address Line 2
Gets or sets Address Line 3
Gets or sets Address Line 4
Gets or sets Description of Geofence
Gets or sets Extended description of Geofence
Gets or sets Semi colon separated email addresses for notifications
Gets or sets Id
Gets or sets Latitude of Geofence
Gets or sets Longitude of Geofence
Gets or sets Radius of Geofence, if needed
POST /public/v1/geofences HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 209
{
"addr1": "text",
"addr2": "text",
"addr3": "text",
"addr4": "text",
"description": "text",
"descriptionExt": "text",
"email": "text",
"geofenceType": 0,
"id": 1,
"latitude": 1,
"longitude": 1,
"radius": 1,
"points": [
[
1
]
],
"tags": [
1
]
}Success
No content
VeriLocation has 2 types of Geofence
Circle Geofences - Are defined by a central
latitudeandlongitudeand aradiusPolygon Geofences - Are defined by a series of 3 or more
points, each a Latitude/Longitude pair that each represent one node in the polygon boundary
Creating Circle Geofences
This type of Geofence is a basic implementation in which the centre of the fenced area is defined by a latitude and longitude along with a radius in metres to define the size of the encompassing area
A circle type Geofence must have a radius of between 50 - 1000 metres
Body Fields - For Circular Geofence
{
"id": 0, // SHOULD ONLY BE INCLUDED ON UPDATE OF EXISTING GEOFENCE
"addr1": "string",
"addr2": "string",
"addr3": "string",
"addr4": "string",
"description": "string", // Required
"descriptionExt": "string",
"email": "string",
"geofenceType": 0, // Required
"latitude": 0, // Required
"longitude": 0, // Required
"radius": 0, // Required
"points": [
[
0, 0
]
],
"tags": [
0
]
}Creating Polygon Geofences
This type of Geofence is a more complex representation on which a series of points are used to define nodes in the perimeter of a Geofence. These nodes are connected by straight lines to produce a geofenced area which can be highly customised.
Body Fields - For Polygon Geofence
{
"id": 0, // SHOULD ONLY BE INCLUDED ON UPDATE OF EXISTING GEOFENCE
"addr1": "string",
"addr2": "string",
"addr3": "string",
"addr4": "string",
"description": "string", // Required
"descriptionExt": "string",
"email": "string",
"geofenceType": 0, // Required
"latitude": 0,
"longitude": 0,
"radius": 0,
"points": [ // Required
[
0, 0
]
],
"tags": [
0
]
}Inputs and InputTypes
inputs in VeriLocation are defined as sensor data from a binary switch. An input in itself can be
1 || 0
and VeriLocation monitors the change in a switch's state to produce a map of when the switch was high and low
inputTypes are an overlay that allows for a context to be assigned to an input. They hold contextual information with reference to the switches name, and inputDescription that describes the real world objects context e.g. what does the switch represent.
1
Door
Open | Closed
2
RefridgerationUnit
On | Off
InputTypes
The POST endpoint for inputTypes allows a new or updated model to be saved to VeriLocation.
Accepts: - Path Parameters: • {inputId} as an integer - Body Parameters: • See associated Schema - Possible inputDesctiptions: 0 = On/Off, 1 = Open/Closed Returns: - Updates the input Type Record associated with {inputTypeId} with new InputType name and inputDescription
POST /public/v1/inputs/types HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 52
{
"inputTypeId": 1,
"name": "text",
"inputDescription": 0
}No content
Body Fields
{
"inputTypeId": 0, // SHOULD ONLY BE INCLUDED ON UPDATE OF EXISTING INPUTTYPE
"name": "string", // Required
"inputDescription": 0 // Required
}Inputs
The POST endpoint for inputs allows an input to be assigned an inputType
Accepts: - Path Parameters: • {inputId} as an integer - Body Parameters: • See associated Schema - Possible inputDesctiptions: 0 = On/Off, 1 = Open/Closed Returns: - Updates the input Record associated with {inputId} with new Input name and inputDescription
POST /public/v1/inputs HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 29
{
"inputId": 1,
"inputTypeId": 1
}No content
Body Fields
{
"inputId": 0, // Required
"inputTypeId": 0 // Required
}Temperature Probes and Profiles
Devices that send temperature data to Verilocation, have their temperature sensors defined as ‘Probes’. Each Temperature Probe represents an individual sensor in situ and connected to a device capable of sending Temperature data.
Each Probe in Verilocation can have a ‘Temperature Profile’ associated with it. These profiles define the upper and lower bounds that are acceptable for a specific Probe and are used to trigger Temperature Alarms, which can be used to set up email and text alerts via the GUI and retrieved via GET endpoints for fleet or vehicle by timeframe.
Temperature Probes
Probes are automatically created by the system and their object models can be retrieved for a fleet or vehicle via GET endpoints.
The POST endpoint for Temperature Probes allows for customisation of the Probes to display a contextual name and set a Temperature Profile for the Probe.
Body Fields
{
“probeId”: 0, // Required
“name”: “string”, // Required
“profileId”: 0 // Required
}Temperature Profiles
Temperature profiles can be created and updated via the POST endpoint. They can be attributed a contextual name for the Profile and two bounds fields which represent the upper and lower bounds, with a Probe entering an Alarm state if any readings fall outside the resulting Temperature range.
Accepts: - Path Parameters: • No path parameters required - Body Parameters: • See associated Schema Notes - To Add a new profile Id == 0, - Created and Updated fields are not required. Returns: - Adds or Updates a Temperature Profile Record
POST /public/v1/temperature/profiles HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 126
{
"id": 1,
"name": "text",
"upperBound": 1,
"lowerBound": 1,
"created": "2025-07-28T19:36:17.265Z",
"updated": "2025-07-28T19:36:17.265Z"
}No content
Body Fields
{
“id”: 0, // SHOULD ONLY BE INCLUDED ON UPDATE OF EXISTING TEMPERATURE PROFILE
“name”: string, // Required
“upperBound”: 0, // Required
“lowerBound”: 0 // Required
}Successful creation or update will return the Id of the Profile.
Verilocation Tags
‘Tags’ are primarily used within Verilocation to
enable a report to be run against a specific subset of a data source, e.g. Vehicles or Drivers, that have been attributed with a specific ‘Tag’.
enable Geofences to be shown in a customisable colour in Verilocation maps
Currently only Creation and Updates to Geofence Tag functionality is available via the v1 API suite
Gets or sets Id of a Tag
Gets or sets the position of a Tag If not supplied will be set to the current maximum position + 1
Gets or sets Name of a Tag
POST /public/v1/tags HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 63
{
"id": 1,
"position": 1,
"name": "text",
"resourceType": 0,
"colour": 0
}Success
1Body Fields
{
“id”: 0, // SHOULD ONLY BE INCLUDED ON UPDATE OF EXISTING TAG
“position”: 0,
“name”: string, // Required
“resourceType”: 0, // Required - Enum as int. NEEDS TO ALWAYS BE SET TO 25 - GEOFENCE
“colour”: 0 // Required - Enum as int
}Last updated