SupaTrak API Documentation

Authentication Methods

To access these API's you will need to provide login credentials of an active SupaTrak user account which has been granted API access.

Asset

The Asset API's allow users to view asset data.

API	Description
GET api/asset/{asset}/{include}	View asset information
PATCH api/asset	Update asset information
GET api/asset/DefectHistory/{id}?startDate={startDate}&endDate={endDate}	Get an assets defect history

Circuit

The Circuit API allow users to view/amend circuit data.

API	Description
GET api/Circuit?circuitId={circuitId}	View circuit information
POST api/Circuit	Add new circuit
PATCH api/Circuit	Update existing circuit

Device

The Asset API's allow users to view asset data.

API	Description
GET api/device/{imei}	View device information

Driver

The Driver API's allow users to view driver data.

API	Description
GET api/Driver?driver={driver}	View driver information
PATCH api/Driver	Patch driver information

Econ

The Econ API allows users to view realtime and historical econ data for assets. Econ data is the raw econ data which has been received from an asset and is not summarised.

API	Description
GET api/econ/current/{asset}	View the latest econ data that has been received
GET api/econ/history/{asset}/{startdate}/{enddate}?checkforgaps={checkforgaps}&include={include}	View all econ data that has been received for a specific asset since a given time, or between 2 timestamps. Up to 1000 records can be requested at a time.

JobTrak

The JobTrak API allows users to extract round Data

API	Description
GET API/JobTrak/NextCollection?page={page}&postcode={postcode}&includeUnsubscribed={includeUnsubscribed}	Next collection dates. Up to 1000 records can be received at once.
GET API/JobTrak/NextCollection/{uprn}?includeUnsubscribed={includeUnsubscribed}	Next collection dates for a UPRN
GET API/JobTrak/UPRNCollections/{uprn}?includeUnsubscribed={includeUnsubscribed}	Get the collection dates of a given UPRN over a 12 month period
GET API/JobTrak/UPRNExceptions/{uprn}	Exceptions for a given UPRN
GET API/JobTrak/GetCustomerAssetBills/{customerAccountNumber}	Asset lift bills for a given Customer
POST API/JobTrak/ImportDomesticRoute	Import route items to build routes. Items not included will be removed from the route
POST API/JobTrak/ImportWasteCustomers	Import Waste Customers for use in Trade Routes
POST API/JobTrak/ImportWasteCustomerProperties	Import Waste Customer Properties for use in Trade Routes
POST API/JobTrak/ImportWasteCustomerAssets	Import Trade Customer Assets for use in Trade Routes
POST API/JobTrak/ImportTradeRoute	Import route items to build routes. Items not included will be removed from the route
POST API/JobTrak/ImportHaulageCustomers	Import customers for use in haulage routes
POST API/JobTrak/ImportHaulageProperties	Import properties for use in haulage routes
POST API/JobTrak/ImportHaulageRoutes	Import route items to build routes. Items not included will be removed from the route
GET API/JobTrak/GetRouteDelays?routeType={routeType}&startDate={startDate}&endDate={endDate}	Get list of route delays
GET API/JobTrak/GetRouteExceptions?routeType={routeType}&startDate={startDate}&endDate={endDate}	Get list of route exceptions
POST API/JobTrak/AssistedCollection/{uprn}	Mark a UPRN as an assisted collection
DELETE API/JobTrak/AssistedCollection/{uprn}	Unmark UPRN as an assisted colleciton
POST API/JobTrak/SpecialInstructions	Mark special instructions on a given UPRN
DELETE API/JobTrak/SpecialInstructions/{uprn}	Remove special instructions on a given UPRN
POST API/JobTrak/SubscribeUPRN/{uprn}?routeName={routeName}&expiryDate={expiryDate}	Mark UPRN as subscribed to route
POST API/JobTrak/UnsubscribeUPRN/{uprn}?routeName={routeName}	Mark UPRN as unsubscribed from route
GET API/JobTrak/GetTradeCustomers	Get list of all trade customers
GET API/JobTrak/GetTradeCustomer/{customerAccountNumber}	Get trade customers by customer account number
POST API/JobTrak/CreateTradeCustomer	Create a trade customer
POST API/JobTrak/UpdateTradeCustomer	Update a trade customer
DELETE API/JobTrak/DeleteTradeCustomer/{wasteCustomerID}	Delete a trade customer
GET API/JobTrak/GetTradeCustomerProperties/{customerAccountNumber}	Get list of customer properties
DELETE API/JobTrak/DeleteTradeProperty/{propertyCode}	Delete a trade property
GET API/JobTrak/GetCustomerBins?customerAccountNumber={customerAccountNumber}	Get a list of trade customer assets
POST API/JobTrak/UpdateTradeAssetProperty	Update a collection of trade asset's associated property by property code
DELETE API/JobTrak/DeleteTradeAsset/{wasteCustomerAssetID}	Delete a trade asset
POST API/JobTrak/GetTradeAssetLifts	Get trade asset lifts

OemJohnstonSweeper

The Johnston Sweeper API's allow users to view realtime and historical telemetry data for assets. Telemetry data is the raw telematics data which has been received from an asset and is not summarised.

API	Description
GET api/telemetry/johnstonsweeper/{asset}/{startdate}/{enddate}	View all telemetry data that has been received for a specific asset since a given time, or between 2 timestamps. Up to 1000 records can be requested at a time.
GET api/telemetry/johnstonsweeper/{nextRecordId}?rowCount={rowCount}	View the next 1000 sweeper telemetry records with sweeper body data

PointOfInterest

API	Description
GET api/poi/all	View all points of interest that the user has access to.
POST api/poi/Import	Import a JArray of points of interest.
DELETE api/poi/delete/{id}	Delete a point of interest that the user has access to.

RemotePackerPressure

A controller to get RemotePackerPressures and assign them to vehicles.

API	Description
GET api/remotepackerpressure/assignment/{asset}	A method returning RemotePackerPressures assigned (and associated assignment details) to one or all assets.
GET api/RemotePackerPressure	A method returning all RemotePackerPressures that are possible to assign to vehicles.
PATCH api/RemotePackerPressure	A method to upsert PatchRemotePackerPressureAssignments.

ServiceRequest

The ServiceRequest API allows users to log service requests

API	Description
GET API/ServiceRequest/ServiceRequestsList/{enquiryId}	Get list of service requests by enquiry ID
POST API/ServiceRequest/ServiceRequestsList	Get list of service requests by Created Time
POST API/ServiceRequest/UpdatedServiceRequests	Get list of service requests by Updated Time
GET API/ServiceRequest/StatusList	Get possible service request statuses
POST API/ServiceRequest/Import	Import a service request
POST API/ServiceRequest/ImportByUprn	Import a Service Request by UPPRN

SmartWitnessCamera

The SmartWitness APIs allow users to schedule historical downloads with custom alert messages for vehicles

API	Description
POST api/swc/scheduledownload?dateTime={dateTime}&asset={asset}&label={label}	Schedules a 20-second-long download from the asset's camera device.

Summary

Main controller for provision of all summary data to users.

API	Description
GET api/summary/sweeper/{asset}/{startDate}/{endDate}?requiredFields={requiredFields}&groupByFields={groupByFields}	View summary data containing fields concerning usage types and times, fuel consumption and more for one or all sweepers for a given date range.
GET api/summary/ecoTrak/{asset}/{startDate}/{endDate}/{requiredFields}/{groupByFields}	View summary data containing EcoTrak fields for one or more assets for a given date range.
POST api/summary/ecoTrak/eedi	Endpoint for passing EcoTrak summary data to calculate EEDI scores.

Telemetry

The Telemetry APIs allow users to view realtime and historical telemetry data for assets. Telemetry data is the raw telematics data which has been received from an asset and is not summarised.

API	Description
GET api/telemetry/current/{asset}?include={include}	View the latest telemetry data that has been received
GET api/telemetry/history/{asset}/{startdate}/{enddate}?checkforgaps={checkforgaps}&include={include}	View all telemetry data that has been received for a specific asset since a given time, or between 2 timestamps. Up to 1000 records can be requested at a time.
GET api/telemetry/history/{recordid}?include={include}	View all telemetry data that has been received since a specific record number. Up to 1000 records can be requested at a time.