This collection includes all the standard HTTP API requests available for the Destiny API.
\nPlease see our Destiny API Quick Start Guide if you haven't yet.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"217817","collectionId":"d3c80dc7-0134-4c17-b9f1-0b02c2cffcb4","publishedId":"TzRLnWp3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-07T17:51:05.000Z"},"item":[{"name":"Admin","item":[{"name":"Send Support Notice Email","id":"1da3bdfe-3429-49e3-a60c-b03468891448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"email@email.co.za\",\n\t\"subject\": \"This is a test email\",\n\t\"body\": \"I need help with this and that.\",\n\t\"priority\": \"low\"\n}"},"url":"{{http}}://{{domain}}/api/v1/admin/email/support/notice","description":"Sends a notice email to support personel.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Sends a warning email to support.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Sends an email about an error to support.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Administratiion related requests.
\n","_postman_id":"f9495aea-10b7-43a4-a52e-485e3518952f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests the data for a previously submitted user registration.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Performs a user login request. If successful an HTTP code 200 OK will be returned together with a new authorization token. Look at the Authorization header in the response, it will contain something like bearer eyJ0eXAiOiJKV1....
\n\nImportant: This token must be cached by you and supplied with each subsequent requests to the API through the
\nAuthorizationHTTP header.
\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Important: The token is refreshed every few minutes by the API server. When any request is made by you and you receive the
\nAuthorizationheader, update your cache with the new token and then send the new token with each subsequent request. The old token does not immediately expire and is valid for 7 days.
Log the user out.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Authenticates a logged-in user with the WebSentinel service.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Performs a password reset request for the given email address.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Performs a password reset based on the provided data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Provide a previous registration token and the users data to complete the user's registration process.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Performs an organizational check for the logged in user. This includes a check whether a GET/POST/PUT/DELETE request can be performed on the supplied partner, agency or client. For convenience this request will return the user's primary details along with the user's permissions.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Authentication related requests.
\n","_postman_id":"b964c6f6-2014-4b52-8a77-8190b9d4fc3f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"A request to see if the server responds to the requests.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"A request to see if the server responds to the requests.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Various API test requests.
\n","_postman_id":"764eb5b4-9b6d-465e-8acd-38c815669385","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests the data of a specific user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Find and/or list users.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Finds users and returns with basic details. Searchable fields are the partner_id, agency_id, client_id, username, email and full_name. Returns the username, email and full_name fields only.
Requests only the id and full name for all the available users with no pagination.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests the data required for a form when creating a new user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Deletes an existing user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Register a new user, the user is sent an email with a link which must be clicked before the registration is complete.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Performs an organizational check for the logged in user. This includes a check whether a GET/POST/PUT/DELETE request can be performed on the supplied partner, agency or client. For convenience this request will return the user's primary details along with the user's permissions.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Updates the current logged in user profile.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests the data of a specific user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"User management requests
\n","_postman_id":"d4b3d3c1-7f0c-4e25-8de4-5a02b32b90e4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Finds one or more unit groups.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests a listing of unit groups which includes the id and name of each unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests the data for a specific unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Request to retrieve the data required for a form when creating a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests the data required to edit an existing unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a new unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Updates an existing unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Deletes an existing unit group.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Unit related requests.
\n","_postman_id":"87638ec4-f68c-4dd1-8610-3e9dbe9facc2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Exclusive is optional.
\nRemove /exclusive to find only units where the type matches /by-type/unit_type_code.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Optional: Add /assigned or /non_assigned after id to get only units assigned to vehicles or units that was not assigned to vehicles.
\nLeave empty to get all units assigned to specific client.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns the current status of all accessable units.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns the current status of all accessable units.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests a summary of unit communication status for a specific clients. The clients id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests a summary of unit communication status for a specific agencies. The agency id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests a summary of unit communication status for a specific partners. The partner id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Requests a summary of unit communication status for a specific partners. The partner id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This request add's an additional text note to the partner.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Creates a safe-zone around a unit. The safe-zone will only be enabled once/if the unit is parked.
\nOnly one safe-zone can be created for a unit. Attempting to create another one will override the original safe-zone.
\nThe radius is in meters.
\nThe mode can be \"private\" or \"monitored\".
\nIn 'private' mode, one or more users of the Destiny mobile app can receive events and alarms for the safe-zone.
\nIn 'monitored' mode, both users and the control room may receive events caused by the safe-zone.
\nDe-allocates a unit from its currently assigned vehicle. Nothing else changes on the unit.
\nunit_id The ID of the unit to be de-allocated.
note A note to be added to the effected unit.
A new unit is fitted to a vehicle replacing an existing faulty unit - which will be archived. All telemetry and trip history are transferred over to the new unit. The old unit is archived to the unit archives.
\nreplaced_unit_id The ID of the unit that is being replaced - i.e. removed from the vehicle.
replacement_unit_id The ID of the replacement unit that is being fitted into the vehicle.
note A note that will be added to the effected units.
A new unit is fitted to a vehicle replacing an existing faulty unit - which will requires repairing. All telemetry and trip history are transferred over to the new unit. The old unit remains under the same client but is no longer allocated to the vehicle.
\nreplaced_unit_id The ID of the unit that is being replaced - i.e. removed from the vehicle.
replacement_unit_id The ID of the replacement unit that is being fitted to the vehicle.
note A note that will be added to the effected units.
Transfer an un-allocated unit to a vehicle's \"primary\", \"backup_1\" or \"backup_2\" slot under the same client. The slot can not be already allocated by another unit. The unit's telemetry and trip data is kept.
\nreplaced_unit_id The ID of the unit that is being transferred to the vehicle.
vehicle_id The ID of the vehicle that the unit is being transferred to.
assigned_as The assignment slot to which the unit should be allocated to, can be \"primary\", \"backup_1\" or \"backup_2\".
note A note that will be added to the effected unit.
Transfer a unit to another client and vehicle. The assigned_as allocation slot, i.e. \"primary\", \"backup_1\" or \"backup_2\" must be provided. The slot can not be already allocated by another unit. The unit's telemetry and trip data is NOT TRANSFERRED.
\nThis API call is usefull for when transferring units from stock or between clients.
\nreplaced_unit_id The ID of the unit that is being transferred to the new client and vehicle.
replacement_client_id The ID of the client to which the unit is being transferred to.
vehicle_id The ID of the vehicle the unit is being transferred to.
assigned_as The assignment slot to which the the vehicle will be allocated to. Can be \"primary\", \"backup_1\" or \"backup_2\".
note A note that will be added to the effected unit.
Transfer a unit to another client without allocating it to a vehicle. This API call is usefull for when transferring units back to stock or between clients.
\nreplaced_unit_id The ID of the unit that is being transferred to the new client.
replacement_client_id The ID of the client to which the unit is being transferred to.
vehicle_id null Indicates that the unit must not be assigned/allocated to a vehicle.
assigned_as null Indicates that the unit must not be assigned/allocated to a vehicle.
note A note that will be added to the effected unit.
A optional partner id can be added.\nTo search for clients without agency assignment under a specific partner.
\nhttps://www.dummydomain.com/api/v1/clients/listing/no-agency/[/1]\n| Id | ","Registration No. | ","Assignment | ","
|---|---|---|
| {{id}} | ",""," {{reg_no}} "," Fleet No: {{fleet_no}}"," | "," "," Partner: {{partner.name}} "," Agency: {{agency.name}} "," Client: {{client.name}} "," | ","
/primary/ can also be /backup_1/ or /backup_2/
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns the latest location status data for each vehicle under a specific client or clients.
\nFollowing are two examples for using this request:
\n/api/v1/vehicles/status/location/by-client/all555. If the user of the API is a client level user, the id will be ignored and only accessable data will be returned: /api/v1/vehicles/status/location/by-client/555Note: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the ?unit_assigned_as=primary filtering parameter, for example:
/api/v1/vehicles/status/location/by-client/all?unit_assigned_as=primary\n\nThe request returns an array of objects having the following fields:
\nid (int): The vehicle's database id.reg_no (string): Vehicle's registration number.fleet_no (string|null): Vehicle's fleet number.vehicle_make (string|null): Vehicle's make.vehicle_model (string|null): Vehicle's model.client_name (string): Client/customer name.driver_name (string|null): Active or assigned Driver name.vehicle_group_name (string|null): Vehicle's group name.unit_assigned_as (string): Can be primary, backup_1, backup_2.local_time (ISO 8601 date and time string|null): The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.timezone (string): The configured/active timezone of the GPS device.latitude (float): The decimal latitude in degrees.longitude (float): The decimal longitude in degrees.speed (int|float): The current GPS speed in km/h.heading (int|float): The current GPS heading in degrees where 0 = North.gps_fix (array of strings): Can be an empty array or have a combination of the following values: \"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\". In most cases the array will be empty or only contain \"on_no_fix\" if there is no GPS fix.odometer (int): Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.address (int|null): Current address of the vehicle if available.hours_behind (float): Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.comms_status_code (string): Current communication status. Can be \"online\", \"inactive\", \"offline\", \"never\".Returns the latest location status data for each vehicle under a specific vehicle group.
\nNote: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the ?unit_assigned_as=primary filtering parameter, for example:
/api/v1/vehicles/status/location/by-client/all?unit_assigned_as=primary\n\nThe request returns an array of objects having the following fields:
\nid (int): The vehicle's database id.
reg_no (string): Vehicle's registration number.
fleet_no (string|null): Vehicle's fleet number.
vehicle_make (string|null): Vehicle's make.
vehicle_model (string|null): Vehicle's model.
client_name (string): Client/customer name.
driver_name (string|null): Active or assigned Driver name.
vehicle_group_name (string|null): Vehicle's group name.
unit_assigned_as (string): Can be primary, backup_1, backup_2.
local_time (ISO 8601 date and time string|null): The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.
timezone (string): The configured/active timezone of the GPS device.
latitude (float): The decimal latitude in degrees.
longitude (float): The decimal longitude in degrees.
speed (int|float): The current GPS speed in km/h.
heading (int|float): The current GPS heading in degrees where 0 = North.
gps_fix (array of strings): Can be an empty array or have a combination of the following values: \"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\". In most cases the array will be empty or only contain \"on_no_fix\" if there is no GPS fix.
odometer (int): Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.
address (int|null): Current address of the vehicle if available.
hours_behind (float): Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.
comms_status_code (string): Current communication status. Can be \"online\", \"inactive\", \"offline\", \"never\".
Returns the latest location and current trip status data (if trip in progress) for each vehicle under a specific client or clients.
\nFollowing are two examples for using this request:
\n/api/v1/vehicles/status/trip/by-client/all555. If the user of the API is a client level user, the id will be ignored and only accessable data will be returned: /api/v1/vehicles/status/trip/by-client/555Note: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the ?unit_assigned_as=primary filtering parameter, for example:
/api/v1/vehicles/status/location/by-client/all?unit_assigned_as=primary\n\nThe request returns an array of objects having the following fields:
\nid (int): The vehicle's database id.reg_no (string): Vehicle's registration number.fleet_no (string|null): Vehicle's fleet number.vehicle_make (string|null): Vehicle's make.vehicle_model (string|null): Vehicle's model.client_name (string): Client/customer name.driver_name (string|null): Active or assigned Driver name.vehicle_group_name (string|null): Vehicle's group name.unit_assigned_as (string): Can be primary, backup_1, backup_2.local_time (ISO 8601 date and time string|null): The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.timezone (string): The configured/active timezone of the GPS device.latitude (float): The decimal latitude in degrees.longitude (float): The decimal longitude in degrees.speed (int|float): The current GPS speed in km/h.heading (int|float): The current GPS heading in degrees where 0 = North.gps_fix (array of strings): Can be an empty array or have a combination of the following values: \"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\". In most cases the array will be empty or only contain \"on_no_fix\" if there is no GPS fix.odometer (int): Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.address (int|null): Current address of the vehicle if available.hours_behind (float): Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.comms_status_code (string): Current communication status. Can be \"online\", \"inactive\", \"offline\", \"never\".The active_trip object contains the following fields and sub-fields:
avg_speed (float): The average speed of the active trip in km/h.
max_speed (float|int): The maximum speed in km/h reached during the active trip.
started_at (ISO 8601 date and time string|null): The local time when the GPS trip started.
distance_km (float): The distance travelled in the active trip.
start_address (string|null): The starting address of the active trip.
durations (Object): The various durations in \"HH:MM:SS\" recorded during the active trip.
Returns the latest location and current active trip status data (if trip in progress) for each vehicle under a specific vehicle group.
\nNote: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the ?unit_assigned_as=primary filtering parameter, for example:
/api/v1/vehicles/status/trip/by-vehicle-group/555?unit_assigned_as=primary\n\nThe request returns an array of objects having the following fields:
\nid (int): The vehicle's database id.reg_no (string): Vehicle's registration number.fleet_no (string|null): Vehicle's fleet number.vehicle_make (string|null): Vehicle's make.vehicle_model (string|null): Vehicle's model.client_name (string): Client/customer name.driver_name (string|null): Active or assigned Driver name.vehicle_group_name (string|null): Vehicle's group name.unit_assigned_as (string): Can be primary, backup_1, backup_2.local_time (ISO 8601 date and time string|null): The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.timezone (string): The configured/active timezone of the GPS device.latitude (float): The decimal latitude in degrees.longitude (float): The decimal longitude in degrees.speed (int|float): The current GPS speed in km/h.heading (int|float): The current GPS heading in degrees where 0 = North.gps_fix (array of strings): Can be an empty array or have a combination of the following values: \"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\". In most cases the array will be empty or only contain \"on_no_fix\" if there is no GPS fix.odometer (int): Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.address (int|null): Current address of the vehicle if available.hours_behind (float): Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.comms_status_code (string): Current communication status. Can be \"online\", \"inactive\", \"offline\", \"never\".The active_trip object contains the following fields and sub-fields:
avg_speed (float): The average speed of the active trip in km/h.max_speed (float|int): The maximum speed in km/h reached during the active trip.started_at (ISO 8601 date and time string|null): The local time when the GPS trip started.distance_km (float): The distance travelled in the active trip.start_address (string|null): The starting address of the active trip.durations (Object): The various durations in \"HH:MM:SS\" recorded during the active trip.| Id | ","Registration No. | ","Assignment | ","
|---|---|---|
| {{id}} | ",""," {{reg_no}} "," Fleet No: {{fleet_no}}"," | "," "," Partner: {{partner.name}} "," Agency: {{agency.name}} "," Client: {{client.name}} "," | ","
| Id | ","Registration No. | ","Assignment | ","
|---|---|---|
| {{id}} | ",""," {{reg_no}} "," Fleet No: {{fleet_no}}"," | "," "," Partner: {{partner.name}} "," Agency: {{agency.name}} "," Client: {{client.name}} "," | ","
Creates a safe-zone around a vehicle. The safe-zone will only be enabled once/if the vehicle is parked.
\nOnly one safe-zone can be created for a vehicle/unit. Attempting to create another one will override the original safe-zone.
\nThe radius is in meters.
\nThe mode can be \"private\" or \"monitored\".
\nIn 'private' mode, one or more users of the Destiny mobile app can receive events and alarms for the safe-zone.
\nIn 'monitored' mode, both users and the control room may receive events caused by the safe-zone.
\nRun a detailed debrief/trip report job on a specific vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a debrief/trip summary report job on a all the vehicles for the specified client and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nOrdery By examples:
\n\"order_by\": \"reg_date\" // Vehicle Registration, Date\n\"order_by\": \"fleet_date\" // Fleet no., Date\n\nPDF Option examples:
\n\"pdf_options\": \"show_veh_sub\" // Show vehicle sub totals\n\"pdf_options\": \"show_sub_only\" // Show sub totals only\n\"pdf_options\": \"skip_veh_sub\" // Skip vehicle sub totals\n\nRun a debrief/trip summary report job on a group of vehicles and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a vehicle analysis report job on a vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a Position Log report job on a vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Note that the `date_range_type` must be set to day for this report.
\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\"time_range_from\": \"00:00:00\"\n\"time_range_to\": \"23:59:59\"\n\nRun a Position Log report job on a unit/device and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Note that the date_range_type must be set to day for this report.
\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\"time_range_from\": \"00:00:00\"\n\"time_range_to\": \"23:59:59\"\n\nRun a Vehicle Expenditure report job on the whole fleet of vehicles for a selected client and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nGroup by examples:
\n\"group_by\": \"vehicle_date\" // Vehicle and invoice date\n\"group_by\": \"invoice_date\" // Invoice date\n\nOrder By examples:
\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"vehicle_fleet_no\"\n\nPDF Option examples:
\n\"pdf_options\": \"show_summary\"\n\"pdf_options\": \"show_summary_only\"\n\"pdf_options\": \"no_summary\"\n\nPDF Chart examples:
\n\"pdf_charts\": \"show\"\n\"pdf_charts\": \"dont_show\"\n\nFilters:
\nThe expense_category filters array can be empty or any combination of these values: \"fuel\", \"general\", \"installments\".
The expense_type filter can be an empty array, and if not, contains an array of id's of the various expense types saved under the client.
The tax_deductable filter can either be empty, \"tax_deductable\" or \"not_tax_deductable\".
Run a Vehicle Expenditure report job on one or more vehicles for a selected client and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nGroup by examples:
\n\"group_by\": \"vehicle_date\" // Vehicle and invoice date\n\"group_by\": \"invoice_date\" // Invoice date\n\nOrder By examples:
\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"vehicle_fleet_no\"\n\nPDF Option examples:
\n\"pdf_options\": \"show_summary\"\n\"pdf_options\": \"show_summary_only\"\n\"pdf_options\": \"no_summary\"\n\nPDF Chart examples:
\n\"pdf_charts\": \"show\"\n\"pdf_charts\": \"dont_show\"\n\nFilters:
\nThe expense_category filters array can be empty or any combination of these values: \"fuel\", \"general\", \"installments\".
The expense_type filter can be an empty array, and if not, contains an array of id's of the various expense types saved under the client.
The tax_deductable filter can either be empty, \"tax_deductable\" or \"not_tax_deductable\".
Run a Vehicle Expenditure report job on one or more vehicles groups for a selected client and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nGroup by examples:
\n\"group_by\": \"vehicle_date\" // Vehicle and invoice date\n\"group_by\": \"invoice_date\" // Invoice date\n\nOrder By examples:
\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"vehicle_fleet_no\"\n\nPDF Option examples:
\n\"pdf_options\": \"show_summary\"\n\"pdf_options\": \"show_summary_only\"\n\"pdf_options\": \"no_summary\"\n\nPDF Chart examples:
\n\"pdf_charts\": \"show\"\n\"pdf_charts\": \"dont_show\"\n\nFilters:
\nThe expense_category filters array can be empty or any combination of these values: \"fuel\", \"general\", \"installments\".
The expense_type filter can be an empty array, and if not, contains an array of id's of the various expense types saved under the client.
The tax_deductable filter can either be empty, \"tax_deductable\" or \"not_tax_deductable\".
Run a Detailed Event report job on an event pool and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Note that the date_range_type must be set to day for the detailed event report.
\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\"time_range_from\": \"00:00:00\"\n\"time_range_to\": \"23:59:59\"\n\nOrder By examples:
\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"gateway_time\"\n\"order_by\": \"stored_time\"\n\"order_by\": \"event_code\"\n\"order_by\": \"importance\"\n\"order_by\": \"alert_level\"\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"vehicle_fleet_no\"\n\"order_by\": \"driver_name\"\n\"order_by\": \"driver_tag_no\"\n\"order_by\": \"unit_imei\"\n\"order_by\": \"unit_serial_no\"\n\"order_by\": \"unit_name\"\n\"order_by\": \"unit_type_code\"\n\"order_by\": \"unit_model\"\n\nSort Order examples:
\n\"sort_order\": \"asc\"\n\"sort_order\": \"desc\"\n\nPDF Option examples:
\n\"pdf_options\": \"show_summary\"\n\"pdf_options\": \"show_summary_only\"\n\"pdf_options\": \"no_summary\"\n\nRun a Summary Event report job on an event pool and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nOrder By examples:
\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"gateway_time\"\n\"order_by\": \"stored_time\"\n\"order_by\": \"event_code\"\n\"order_by\": \"importance\"\n\"order_by\": \"alert_level\"\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"vehicle_fleet_no\"\n\"order_by\": \"driver_name\"\n\"order_by\": \"driver_tag_no\"\n\"order_by\": \"unit_imei\"\n\"order_by\": \"unit_serial_no\"\n\"order_by\": \"unit_name\"\n\"order_by\": \"unit_type_code\"\n\"order_by\": \"unit_model\"\n\nSort Order examples:
\n\"sort_order\": \"asc\"\n\"sort_order\": \"desc\"\n\nPDF Option examples:
\n\"pdf_options\": \"show_summary\"\n\"pdf_options\": \"show_summary_only\"\n\"pdf_options\": \"no_summary\"\n\nRun a Detailed Unit Operationl Status report job and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
If no partner_id, agency_id or client_id is provided or these three fields are null, then the report will return with all the accessable units available to the user.
If only a partner_id is provided, then all the units of that partner is returned.
If an agency_id is provided and no client_id, then all the units of that agency will be returned.
If only a client_id is provided, then all the units of that client will be returned.
The comms_status_code filter can be any one or combination of the following:
\"comms_status_code\": [\"active\"]\n\"comms_status_code\": [\"inactive\"]\n\"comms_status_code\": [\"offline\"]\n\"comms_status_code\": [\"never\"]\n\nFor example:
\n\"comms_status_code\": [\"active\", \"offline\"]\n\nPlease contact us for a list of unit_type_code, unit_model_code and unit_status_code codes:
Order By examples:
\n\"order_by\": \"vehicle_reg_no\"\n\"order_by\": \"partner_name,agency_name,client_name,!local_time\" // Client, GPS Timestamp\n\"order_by\": \"partner_name,agency_name,client_name,comms_status_code\" // Client, Comms Status\n\"order_by\": \"!local_time\" // GPS Timestamp (descending order)\n\"order_by\": \"comms_status_code\" // Comms status code\n\nRun a Unit Communication Status Summary report job and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
If no partner_id, agency_id or client_id is provided or these three fields are null, then the report will return with all the accessable units available to the user.
If only a partner_id is provided, then all the units of that partner is returned.
If an agency_id is provided and no client_id, then all the units of that agency will be returned.
If only a client_id is provided, then all the units of that client will be returned.
The comms_status_code filter can be any one or combination of the following:
\"comms_status_code\": [\"active\"]\n\"comms_status_code\": [\"inactive\"]\n\"comms_status_code\": [\"offline\"]\n\"comms_status_code\": [\"never\"]\n\nFor example:
\n\"comms_status_code\": [\"active\", \"offline\"]\n\nPlease contact us for a list of unit_type_code, unit_model_code and unit_status_code codes:
Run a detailed debrief/trip report job on a specific vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a detailed debrief/trip report job on a specific vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a detailed debrief/trip report job on a specific vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a detailed debrief/trip report job on a specific vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a detailed debrief/trip report job on a specific vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\nRun a detailed debrief/trip report job on a specific vehicle and generate a PDF file.
\nImportant: This starts a background job which will run asynchronously, and as such the results of the report is not returned immediately. Instead, the front-end can use an SSE connection to get feedback on the report or alternatively poll the report status using the Get Report by Id request.
Date range example 1:
\n\"date_range_type\": \"day\"\n\"date_range_day\": \"2023-12-06\"\n\nDate range example 2:
\n\"date_range_type\": \"month\"\n\"date_range_month\": \"2023-12\"\n\nDate range example 3:
\n\"date_range_type\": \"date_range\"\n\"date_range_from\": \"2023-12-01\"\n\"date_range_to\": \"2023-12-06\"\n\n