Account
API controller for creating tokens.
| API | Description | 
|---|---|
| POST api/account | 
                 POST api/account Example - http://restapi.matrixtelematics.com/api/Account { "username": "yourusername", "password": "yourpassword" }  | 
        
| DELETE api/account?token={token} | 
                 DELETE api/account/{guid} Example - http://restapi.matrixtelematics.com/api/Account/token?token=5a6b70a6-1428-4c87-b632-0433204a3f46  | 
        
| DELETE api/account/{token} | 
                 DELETE api/account/{guid} Example - http://restapi.matrixtelematics.com/api/Account/token?token=5a6b70a6-1428-4c87-b632-0433204a3f46  | 
        
AEMP
| API | Description | 
|---|---|
| GET api/AEMP | 
                 View data in AEMP format.  | 
        
AEMPV2
| API | Description | 
|---|---|
| GET api/AEMPV2 | 
                 View vehicle data in AEMP v2 format.  | 
        
AlertNotification
API controller for alert notifications
| API | Description | 
|---|---|
| GET api/alertnotification?userID={userID}&token={token} | |
| GET api/alertnotification/{userID}/{token} | |
| DELETE api/alertnotification?userID={userID}&token={token} | 
                 mark all alert notifcations as having been read for this user  | 
        
| DELETE api/alertnotification/{userID}/{token} | 
                 mark all alert notifcations as having been read for this user  | 
        
CloudConnect
| API | Description | 
|---|---|
| GET api/cloudconnectbackfill/authorise?code={code} | 
                 Sign up to the backfill  | 
        
| GET api/cloudconnect/authorise?code={code} | 
                 Register / refresh for KeepTruckin polling. Logs 45 days and web exp. 64check  | 
        
CorrectAI
| API | Description | 
|---|---|
| POST api/correctai?validationToken={validationToken} | 
                 Webhook setup  | 
        
| POST api/correctai | 
                 No documentation available.  | 
        
DeviceAssociation
Controller used to associate devices to new services and activate its sim card
| API | Description | 
|---|---|
| POST api/installation/deviceassociation | 
                 Associate a service to a device into the unalloacted group.  | 
        
DeviceDisassociation
Controller used to disassociate devices from a service
| API | Description | 
|---|---|
| POST api/installation/devicedisassociation | 
                 Remove a imei of a service and put the service into the disposed group  | 
        
DeviceDispose
Controller used to dispose devices and cut their sim card
| API | Description | 
|---|---|
| POST api/installation/devicedispose | 
                 Dispose services which are no longer needed  | 
        
DeviceIMEISwap
Controller used to change the device on a service
| API | Description | 
|---|---|
| POST api/installation/deviceimeiswap | 
                 Swap an imei from the unallocated group and put it onto an existing service  | 
        
DriiveAcademy
| API | Description | 
|---|---|
| GET api/DriiveAcademy/Course | 
                 Get all available driive academy courses  | 
        
| GET api/DriiveAcademy/Group/{groupId}/Driver/AssignedCourse | 
                 Get the assigned courses for all drivers in a group  | 
        
| GET api/DriiveAcademy/Driver/{assetId}/AssignedCourse | 
                 Get the courses a driver has had assigned  | 
        
| POST api/DriiveAcademy/Course/Assign | 
                 Assign drivers to a course  | 
        
| GET api/DriiveAcademy/DriverCourse?driverCourseId={driverCourseId} | 
                 Get driver courses by id  | 
        
| GET api/DriiveAcademy/DriverCourse/{driverCourseId} | 
                 Get driver courses by id  | 
        
| GET api/DriiveAcademy/DriverCourse | 
                 Get all driver courses  | 
        
| PUT api/DriiveAcademy/DriverCourse/{driverCourseId}/status | 
                 Update the status of a driver course  | 
        
| POST api/DriiveAcademy/DriverCourse?driverCourseId={driverCourseId} | 
                 Submit responses for a driver course.  | 
        
| POST api/DriiveAcademy/DriverCourse/{driverCourseId} | 
                 Submit responses for a driver course.  | 
        
DriiveAssessment
| API | Description | 
|---|---|
| GET api/DriiveAssessment/Drivers/{username}/DriverAssessment | 
                 Get all the driver assessments for a driver  | 
        
| POST api/DriiveAssessment/DriverAssessment?driverAssessmentId={driverAssessmentId} | 
                 Submit responses for an assessment  | 
        
| POST api/DriiveAssessment/DriverAssessment/{driverAssessmentId} | 
                 Submit responses for an assessment  | 
        
DriiveDocument
Request details of documents available to download
| API | Description | 
|---|---|
| GET api/driive/document?driverId={driverId}&token={token} | 
                 Get the document a driver can see  | 
        
| GET api/driive/document/{driverId}/{token} | 
                 Get the document a driver can see  | 
        
DriiveDocumentDownload
Download documents
| API | Description | 
|---|---|
| GET api/driive/documentdownload?driverId={driverId}&token={token}&documentId={documentId} | 
                 Get the document a driver can see  | 
        
| GET api/driive/documentdownload/{driverId}/{token}/{documentId} | 
                 Get the document a driver can see  | 
        
DriiveDocumentStatus
Update the status of document downloads
| API | Description | 
|---|---|
| POST api/driive/documentstatus | 
                 Update a document status  | 
        
DriiveFNOLDetails
Send FNOL details
| API | Description | 
|---|---|
| POST api/driive/fnoldetails | 
                 Create details of an accident  | 
        
DriverAccount
Used to log into mobile applications using a driver
| API | Description | 
|---|---|
| POST api/classe/driveraccount | 
                 Request a token for a driver  | 
        
DriverAppPermission
Check a drivers permission for application features
| API | Description | 
|---|---|
| GET api/mobile/driverapppermission?driverId={driverId}&token={token} | 
                 Get the application permissions a driver has  | 
        
| GET api/mobile/driverapppermission/{driverId}/{token} | 
                 Get the application permissions a driver has  | 
        
DriverAssetTelemetry
| API | Description | 
|---|---|
| POST api/mobile/driverassettelemetry | 
                 Get driver telemetry by asset  | 
        
DriverForgotPassword
| API | Description | 
|---|---|
| POST api/mobile/driverforgotpassword | 
                 No documentation available.  | 
        
DriverForgotPasswordVerification
| API | Description | 
|---|---|
| POST api/mobile/driverforgotpasswordverification | 
                 No documentation available.  | 
        
DriverJourney
| API | Description | 
|---|---|
| POST api/mobile/driverjourney | 
                 Get driver journeys  | 
        
DriverLink
| API | Description | 
|---|---|
| POST api/mobile/driverlink | 
                 Link an asset to a service  | 
        
DriverLinkedVehicle
Get a drivers linked vehicle
| API | Description | 
|---|---|
| GET api/mobile/driverlinkedvehicle?driverID={driverID}&token={token} | 
                 Get the current linked vehicle for a driver  | 
        
| GET api/mobile/driverlinkedvehicle/{driverID}/{token} | 
                 Get the current linked vehicle for a driver  | 
        
DriverPasswordReset
| API | Description | 
|---|---|
| POST api/mobile/driverpasswordreset | 
                 Reset a drivers password  | 
        
DriverScore
| API | Description | 
|---|---|
| POST api/mobile/driverscore | 
                 Get driver scores  | 
        
DriverShift
| API | Description | 
|---|---|
| POST api/classe/drivershift | 
                 No documentation available.  | 
        
DriverSupportContact
| API | Description | 
|---|---|
| GET api/mobile/driversupportcontact?driverId={driverId}&token={token} | 
                 Get support telephone numbers for mobile applications  | 
        
| GET api/mobile/driversupportcontact/{driverId}/{token} | 
                 Get support telephone numbers for mobile applications  | 
        
DriverTelemetry
| API | Description | 
|---|---|
| POST api/mobile/drivertelemetry | 
                 Get driver telemetry  | 
        
DriverVehicle
Get a list of vehicles a driver can operate
| API | Description | 
|---|---|
| GET api/classe/drivervehicle?driverID={driverID}&token={token} | 
                 Get a list of vehicles for this driver  | 
        
| GET api/classe/drivervehicle/{driverID}/{token} | 
                 Get a list of vehicles for this driver  | 
        
EmailConfirmation
Subscribe and cancel email alerts
| API | Description | 
|---|---|
| GET api/emailconfirmation?confirmationType={confirmationType}&subscriptionAction={subscriptionAction}&guid={guid}&reportId={reportId} | 
                 Subscribe or unsubscribe  | 
        
| GET api/emailconfirmation/{confirmationType}/{subscriptionAction}/{guid}/{reportId} | 
                 Subscribe or unsubscribe  | 
        
Event
| API | Description | 
|---|---|
| POST api/adasevents | 
                 Create an Adas event and download the video  | 
        
Firmware
| API | Description | 
|---|---|
| GET fw?version={version}&user={user}&pwd={pwd}&image={image}&offset={offset} | 
                 Get firmware  | 
        
| GET fw/{version}/{user}/{pwd}/{image}/{offset} | 
                 Get firmware  | 
        
| GET fw/{version}/{user}/{pwd}/info | 
                 Get info for a firmware  | 
        
| GET fw/{version}/{imei} | 
                 Queue a firmware update for a device  | 
        
| GET fw/raw/{imei}/{start}/{end}/{password} | 
                 Get raw messages for an imei  | 
        
FleetAdditTelem
| API | Description | 
|---|---|
| GET api/fleet/addittelem?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to}&msgType={msgType} | 
                 Maps to the getAdditionalTelemetryForDateTimeServiceId and getAdditionalTelemetryForDateTimeTypeServiceId methods from the Fleet Web Service  | 
        
| GET api/fleet/addittelem/{userID}/{token}/{serviceID}/{from}/{to}/{msgType} | 
                 Maps to the getAdditionalTelemetryForDateTimeServiceId and getAdditionalTelemetryForDateTimeTypeServiceId methods from the Fleet Web Service  | 
        
FleetDriverScore
| API | Description | 
|---|---|
| GET api/fleet/driverscore?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to} | 
                 return the drivers score for the selected period Maps to the GetDriverScoreExtended method from the Fleet Web Service  | 
        
| GET api/fleet/driverscore/{userID}/{token}/{serviceID}/{from}/{to} | 
                 return the drivers score for the selected period Maps to the GetDriverScoreExtended method from the Fleet Web Service  | 
        
FleetJourney
| API | Description | 
|---|---|
| GET api/fleet/journey?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to}&showTowJourney={showTowJourney} | 
                 Gets a list of journeys for the authenticated user - Maps to the GetJourneys method from the Fleet Web Service  | 
        
| GET api/fleet/journey/{userID}/{token}/{serviceID}/{from}/{to}/{showTowJourney} | 
                 Gets a list of journeys for the authenticated user - Maps to the GetJourneys method from the Fleet Web Service  | 
        
FleetServiceStatus
| API | Description | 
|---|---|
| GET api/fleet/servicestatus?userID={userID}&token={token}&serviceID={serviceID} | 
                 Gets either an individual service status or all for the user services Maps to the GetAllCurrentServiceStatuses and GetServiceStatusByServiceId methods from the Fleet Web Service  | 
        
| GET api/fleet/servicestatus/{userID}/{token}/{serviceID} | 
                 Gets either an individual service status or all for the user services Maps to the GetAllCurrentServiceStatuses and GetServiceStatusByServiceId methods from the Fleet Web Service  | 
        
FleetTelem
| API | Description | 
|---|---|
| GET api/fleet/telem?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to}&msgType={msgType} | 
                 Maps to the getTelemetryDataForDateTimeServiceId and getTelemetryDataForDateTimeServiceIdMsgType methods from the Fleet Web Service  | 
        
| GET api/fleet/telem/{userID}/{token}/{serviceID}/{from}/{to}/{msgType} | 
                 Maps to the getTelemetryDataForDateTimeServiceId and getTelemetryDataForDateTimeServiceIdMsgType methods from the Fleet Web Service  | 
        
FleetVehicle
| API | Description | 
|---|---|
| GET api/fleet/vehicle?userID={userID}&token={token} | 
                 Gets a list of vehicle IDs for the authenticated user - Maps to the GetVehicleIds method from the Fleet Web Service  | 
        
| GET api/fleet/vehicle/{userID}/{token} | 
                 Gets a list of vehicle IDs for the authenticated user - Maps to the GetVehicleIds method from the Fleet Web Service  | 
        
Flock
| API | Description | 
|---|---|
| POST api/flock/journey | 
                 Create a journey  | 
        
Geotab
Geotab methods
| API | Description | 
|---|---|
| GET geotab/device/alert?serialNumber={serialNumber} | 
                 Get the geotab alerts for a device  | 
        
| POST geotab/device/alert | 
                 Create a geotab alert and confirmation email  | 
        
| DELETE geotab/device/alert | 
                 Delete a geotab alert  | 
        
| PATCH geotab/device/alert | 
                 Update a geotab alert  | 
        
| POST geotab/device/alert/sendEmailVerification | 
                 Resend the email verification link to emails which are not verified  | 
        
| GET geotab/device/configuration/possible?serialNumber={serialNumber} | 
                 Gets all possible configurations for a device  | 
        
| GET geotab/device/configuration?serialNumber={serialNumber} | 
                 Get the configuration a device is set to  | 
        
| PUT geotab/device/configuration | 
                 Update the config on a device with pro  | 
        
| GET geotab/device?serialNumber={serialNumber} | 
                 Get details of a geotab device  | 
        
| PATCH geotab/device | 
                 Update a geotab device  | 
        
| POST geotab/device/vehicleregistration | 
                 Update the vehicle reg for geotab devices  | 
        
| POST api/Geotab?alertType={alertType}&alertId={alertId} | 
                 No documentation available.  | 
        
GreyFleet
| API | Description | 
|---|---|
| GET apioauth/greyfleet/driver | 
                 Get a grey fleet driver  | 
        
| PATCH apioauth/greyfleet/driver | 
                 Patch an existing grey fleet driver.  | 
        
| POST apioauth/greyfleet/driver | 
                 Create a grey fleet driver  | 
        
Group
API controller for retreiving group lists
| API | Description | 
|---|---|
| GET api/group?userID={userID}&token={token}&groupID={groupID} | 
                 Get a list of GroupResponse by groupID  | 
        
| GET api/group/{userID}/{token}/{groupID} | 
                 Get a list of GroupResponse by groupID  | 
        
HireAccount
Controller used to request a token for a user
| API | Description | 
|---|---|
| POST api/hire/account | 
                 Request a token allowing use of the API  | 
        
HireDeviceAssociationV2
Controller used to associate devices to new services
| API | Description | 
|---|---|
| POST api/hirev2/deviceassociationv2 | 
                 Creates a new service and associates an existing device to it  | 
        
HireDeviceRemovalV2
Controller used to remove devices from a service
| API | Description | 
|---|---|
| POST api/hirev2/deviceremovalv2 | 
                 Remove a device from a service so the device can be used again  | 
        
HireNotificationCancel
Controller used to cancel a mobile device from receiving notifications
| API | Description | 
|---|---|
| POST api/hire/notificationcancel | 
                 Attempt to cancel a mobile notification subscription  | 
        
HireNotificationSubscription
Controller used to assign mobile devices to a SNS endpoint
| API | Description | 
|---|---|
| POST api/hire/notificationsubscription | 
                 Attempt to subscribe a mobile device to a SNS application  | 
        
HireOffHireV2
Controller used to take equipment off hire
| API | Description | 
|---|---|
| POST api/hirev2/offhirev2 | 
                 Set equipment on hire  | 
        
HireOnHireV2
Controller used to associate equipment to the correct account on the portal
| API | Description | 
|---|---|
| POST api/hirev2/onhirev2 | 
                 Set equipment on hire  | 
        
HireRequestChildUsers
Controller used to request a users child users
| API | Description | 
|---|---|
| POST api/hire/requestchildusers | 
                 Request a users child users  | 
        
HireRequestUtilisation
Controller used to request equipment utilisation
| API | Description | 
|---|---|
| POST api/hire/requestutilisation | 
                 Request the utilisation of equipment  | 
        
HireRequestUtilisationMobile
Controller used to request equipment utilisation for use by mobile devices
| API | Description | 
|---|---|
| POST api/hire/requestutilisationmobile | 
                 Request the utilisation of equipment  | 
        
HireRequestUtilisationV2
Controller used to request equipment utilisation
| API | Description | 
|---|---|
| POST api/hirev2/requestutilisationv2 | 
                 Request the utilisation of equipment  | 
        
HireServiceStatusLite
Controller used to pull back service status for use by mobile devices
| API | Description | 
|---|---|
| POST api/hire/servicestatuslite | 
                 Request service status - Service id takes priority in searches  | 
        
IndafitAccount
| API | Description | 
|---|---|
| POST api/indafit/account | 
                 POST api/account Example - http://restapi.matrixtelematics.com/api/Indafit/Account { "username": "yourusername", "password": "yourpassword" }  | 
        
| DELETE api/indafit/account?token={token} | 
                 DELETE api/account/{guid} Example - http://restapi.matrixtelematics.com/api/Account/token?token=5a6b70a6-1428-4c87-b632-0433204a3f46  | 
        
| DELETE api/indafit/account/{token} | 
                 DELETE api/account/{guid} Example - http://restapi.matrixtelematics.com/api/Account/token?token=5a6b70a6-1428-4c87-b632-0433204a3f46  | 
        
IndafitIMEICheck
| API | Description | 
|---|---|
| GET api/indafit/imeicheck?userID={userID}&token={token}&imei={imei}&vehicleReg={vehicleReg} | 
                 performs a check to see if the imei exists in the system. If it does, the vehicle reg is checked, a service is created and the device is bound to the newly created service  | 
        
IndafitInstallationCheck
| API | Description | 
|---|---|
| GET api/indafit/installationcheck?userID={userID}&token={token}&serviceID={serviceID} | 
                 take the supplied service id and check the input status' for the installation check and return the values  | 
        
| GET api/indafit/installationcheck?userID={userID}&token={token}&imei={imei} | 
                 take the supplied service id and check the input status' for the installation check and return the values  | 
        
Installation
InstallationPortal
| API | Description | 
|---|---|
| POST apioauth/installationportal/twofactor | 
                 Request a code  | 
        
| POST apioauth/installationportal/twofactor/validate | 
                 Validate a code  | 
        
| DELETE apioauth/installationportal/photos/{photoId} | 
                 Delete a photo by its id  | 
        
| GET apioauth/installationportal/services/{serviceId}/photos | 
                 Return all photos for a service  | 
        
| POST apioauth/installationportal/services/{serviceId}/photos | 
                 Post an image for a service  | 
        
| GET apioauth/installationportal/devices/{imei} | 
                 Query a service based on an imei  | 
        
| PATCH apioauth/installationportal/services/{serviceId} | 
                 Patch a service to change its registration and install date  | 
        
MatrixV2
V2 Api methods
MFA
| API | Description | 
|---|---|
| POST apioauth/mfa/validate | 
                 Validate a mfa code  | 
        
| POST apioauth/mfa/create | 
                 Create a mfa code for a user  | 
        
MobileGroup
| API | Description | 
|---|---|
| GET api/mobile/mobilegroup?userID={userID}&token={token}&groupID={groupID} | 
                 Get groups for a user  | 
        
| GET api/mobile/mobilegroup/{userID}/{token}/{groupID} | 
                 Get groups for a user  | 
        
| POST api/mobile/mobilegroup | 
                 Get groups for a user  | 
        
MobileService
| API | Description | 
|---|---|
| POST api/mobile/mobileservice | 
                 Get information about the services in a group or a list of services  | 
        
| GET api/mobile/mobileservice?userID={userID}&token={token}&groupID={groupID}&serviceIDs={serviceIDs} | 
                 Get information about the services in a group or a list of services  | 
        
| GET api/mobile/mobileservice/{userID}/{token}/{groupID}?serviceIDs={serviceIDs} | 
                 Get information about the services in a group or a list of services  | 
        
| GET api/mobile/mobileservice/{userID}/{token}/{groupID}/{serviceIDs} | 
                 Get information about the services in a group or a list of services  | 
        
MobileServiceJourney
| API | Description | 
|---|---|
| GET api/mobile/mobileservicejourney?userID={userID}&token={token}&serviceID={serviceID}&startDate={startDate}&endDate={endDate} | 
                 No documentation available.  | 
        
| GET api/mobile/mobileservicejourney/{userID}/{token}/{serviceID}/{startDate}/{endDate} | 
                 No documentation available.  | 
        
| POST api/mobile/mobileservicejourney | 
                 No documentation available.  | 
        
MobileServiceJourneySummary
| API | Description | 
|---|---|
| POST api/mobile/mobileservicejourneysummary | 
                 Get a journey summary for a collection of services  | 
        
| GET api/mobile/mobileservicejourneysummary?userID={userID}&token={token}&serviceIDs={serviceIDs}&startDate={startDate}&endDate={endDate} | 
                 Get a journey summary for a collection of services  | 
        
| GET api/mobile/mobileservicejourneysummary/{userID}/{token}/{serviceIDs}/{startDate}/{endDate} | 
                 Get a journey summary for a collection of services  | 
        
MobileServiceTelemetry
Get telemetry for a service
| API | Description | 
|---|---|
| POST api/mobile/mobileservicetelemetry | 
                 View telemetry for a service  | 
        
| GET api/mobile/mobileservicetelemetry?userID={userID}&token={token}&serviceID={serviceID}&startDate={startDate}&endDate={endDate} | 
                 View telemetry for a service  | 
        
| GET api/mobile/mobileservicetelemetry/{userID}/{token}/{serviceID}/{startDate}/{endDate} | 
                 View telemetry for a service  | 
        
OAuth
Used to create and refresh access tokens
| API | Description | 
|---|---|
| POST OAuth/token | 
                 Request or refresh a token  | 
        
OAuthAssetMethods
Methods ran on assets which use OAuth authentication
OAuthMethods
Methods which use OAuth authentication
OAuthMobileMethods
Mobile methods which use OAuth authentication
OneStop
| API | Description | 
|---|---|
| POST api/onestop/telemetry | 
                 Post telemetry to onestop  | 
        
OutputState
| API | Description | 
|---|---|
| GET api/actions/outputstate?userID={userID}&token={token}&serviceID={serviceID}&outputNumber={outputNumber}&outputState={outputState} | 
                 Set the output states on a device  | 
        
| GET api/actions/outputstate/{userID}/{token}/{serviceID}/{outputNumber}/{outputState} | 
                 Set the output states on a device  | 
        
POIAlertsCreateEdit
Controller used to create and edit poi alerts
| API | Description | 
|---|---|
| POST api/poialerts/createedit | 
                 Create of edit POI Alerts  | 
        
POIAlertsDelete
| API | Description | 
|---|---|
| POST api/poialerts/delete | 
                 No documentation available.  | 
        
POIAlertsGet
| API | Description | 
|---|---|
| POST api/poialerts/get | 
                 Get POI Alert Details  | 
        
POICreateEdit
Controller used to create and edit pois
| API | Description | 
|---|---|
| POST api/poi/createedit | 
                 Create or edit POIs  | 
        
POIDelete
Controller used to delete POIS
| API | Description | 
|---|---|
| POST api/poi/delete | 
                 Delete any desired POIS  | 
        
POIGet
Controller used to view POIs
| API | Description | 
|---|---|
| POST api/poi/get | 
                 Get a collection of pois  | 
        
PostLog
| API | Description | 
|---|---|
| POST api/actions/postlog | 
                 No documentation available.  | 
        
ReceiveprvMessage
| API | Description | 
|---|---|
| POST api/GlobalStar/ReceivePrvMessage | 
                 No documentation available.  | 
        
ReceiveStuMessage
| API | Description | 
|---|---|
| POST api/GlobalStar/ReceiveStuMessage | 
                 No documentation available.  | 
        
RequestVehicleCheckPDF
Request historical vehicle check PDFs
| API | Description | 
|---|---|
| POST api/classe/requestvehiclecheckpdf | 
                 Request historical vehicle check PDFs  | 
        
SmartView
| API | Description | 
|---|---|
| GET api/smartview/dashboard?userArn={userArn} | 
                 Get dashboards by a user  | 
        
| GET api/smartview/embeddedurl?userArn={userArn}&dashboardId={dashboardId} | 
                 Get an embedded url for a dashboard  | 
        
| GET api/smartview/embeddedurl?userArn={userArn}&dashboardId={dashboardId}&domain={domain} | 
                 Get an embedded url for a dashboard for the supplied domain  | 
        
| GET api/smartview/usernamearn?email={email} | 
                 Get a username and arn from the database with sso support eg azure.  | 
        
| GET api/SmartView?email={email} | 
                 Get SSO Details for a username/email.  | 
        
SocialDriver
Methods for social driver
SureTrackSMS
| API | Description | 
|---|---|
| POST api/suretracksms | 
                 Receive an ST SMS from Octal  | 
        
| GET api/suretracksms?smsBody={smsBody}&handsetNumber={handsetNumber} | 
                 Start the decoding process off  | 
        
| GET api/suretracksms/{smsBody}/{handsetNumber} | 
                 Start the decoding process off  | 
        
| PUT api/suretracksms | 
                 No documentation available.  | 
        
Telemetry
| API | Description | 
|---|---|
| POST api/weme/telemetry | 
                 Save telemetry from a WEME device  | 
        
ToolTrack
| API | Description | 
|---|---|
| GET apioauth/tooltrack/asset/{tagId} | 
                 Query a tool track asset using the tag id  | 
        
| GET apioauth/tooltrack/asset?tagId={tagId} | 
                 Query a tool track asset using the tag id  | 
        
| PATCH apioauth/tooltrack/asset/{tagId} | 
                 Update a tool track asset's details.  | 
        
| PATCH apioauth/tooltrack/asset?tagId={tagId} | 
                 Update a tool track asset's details.  | 
        
| POST apioauth/tooltrack/asset/{tagId}/photos | 
                 Add an image to a tool track asset  | 
        
| DELETE apioauth/tooltrack/asset/photos/{photoId} | 
                 Delete a photo for a tool track asset  | 
        
| GET apioauth/tooltrack/groups/{groupId}/telemetry | 
                 Get the latest asset telemetry for all bluetooth assets in a group  | 
        
| GET apioauth/tooltrack/asset/telemetry/{tagId}/{startDate}/{endDate} | 
                 Get telemetry for an asset  | 
        
| GET apioauth/tooltrack/asset/telemetry?tagId={tagId}&startDate={startDate}&endDate={endDate} | 
                 Get telemetry for an asset  | 
        
ToolTrackV2
Tooltrack Api methods
| API | Description | 
|---|---|
| PATCH apioauth/tooltrackv2/assets/{assetId} | 
                 Patch an asset  | 
        
| GET apioauth/tooltrackv2/assets/{tagId} | 
                 Get an asset by its tag id  | 
        
| GET apioauth/tooltrackv2/depots | 
                 Get all visible depots  | 
        
| GET apioauth/tooltrackv2/groups/{groupId}/depots | 
                 Get all visible depots by group id  | 
        
| PUT apioauth/tooltrackv2/items/{itemId}/unlinkservice | 
                 Remove a service from an item  | 
        
| PUT apioauth/tooltrackv2/items/{itemId}/unlink | 
                 Remove an asset from an item  | 
        
| POST apioauth/tooltrackv2/depots/{depotId}/items | 
                 Create a blank item in a depot.  | 
        
| PATCH apioauth/tooltrackv2/items/{itemId} | 
                 Patch an item, will alert on low stock  | 
        
| GET apioauth/tooltrackv2/depots/{depotId}/items | 
                 Get the items for a depot  | 
        
UnitMonitor
| API | Description | 
|---|---|
| GET api/monitoring/unitmonitor?userID={userID}&token={token}&serviceID={serviceID} | 
                 Monitoring controller for use by Matrix staff  | 
        
| GET api/monitoring/unitmonitor/{userID}/{token}/{serviceID} | 
                 Monitoring controller for use by Matrix staff  | 
        
UpdateDriver
Update a driver's details
| API | Description | 
|---|---|
| POST api/mobile/updatedriver | 
                 Update a driver's details  | 
        
UserForgotPassword
Controller used to request a user's password to be reset
| API | Description | 
|---|---|
| POST api/mobile/userforgotpassword | 
                 Request a user password reset token  | 
        
| GET api/mobile/userforgotpassword?userName={userName} | 
                 Request a user password reset token  | 
        
| GET api/mobile/userforgotpassword/{userName} | 
                 Request a user password reset token  | 
        
UserForgotPasswordVerification
Controller used to change a user's password to be reset
| API | Description | 
|---|---|
| POST api/mobile/userforgotpasswordverification | 
                 Change a user's password  | 
        
| GET api/mobile/userforgotpasswordverification?emailAddress={emailAddress}&passwordResetToken={passwordResetToken}&newPassword={newPassword} | 
                 Change a user's password  | 
        
| GET api/mobile/userforgotpasswordverification/{emailAddress}/{passwordResetToken}/{newPassword} | 
                 Change a user's password  | 
        
UserPasswordReset
| API | Description | 
|---|---|
| POST api/mobile/userpasswordreset | 
                 Reset a password  | 
        
| GET api/mobile/userpasswordreset?userID={userID}&token={token}&oldPassword={oldPassword}&newPassword={newPassword} | 
                 Reset a password  | 
        
| GET api/mobile/userpasswordreset/{userID}/{token}/{oldPassword}/{newPassword} | 
                 Reset a password  | 
        
V4Asset
| API | Description | 
|---|---|
| GET api/v4/asset?userID={userID}&token={token}&assetID={assetID}&groupID={groupID} | 
                 Get a list of assets by asset id or by group id  | 
        
| GET api/v4/asset/{userID}/{token}/{assetID}/{groupID} | 
                 Get a list of assets by asset id or by group id  | 
        
V4AssetJourney
| API | Description | 
|---|---|
| GET api/v4/assetjourney?userID={userID}&token={token}&assetID={assetID}&from={from}&to={to}&showTowJourney={showTowJourney}&mileageType={mileageType} | 
                 Gets a list of journeys by asset id  | 
        
| GET api/v4/assetjourney/{userID}/{token}/{assetID}/{from}/{to}/{mileageType}?showTowJourney={showTowJourney} | 
                 Gets a list of journeys by asset id  | 
        
| GET api/v4/assetjourney/{userID}/{token}/{assetID}/{from}/{to}/{showTowJourney}/{mileageType} | 
                 Gets a list of journeys by asset id  | 
        
| GET api/v4/assetjourney/{userID}/{token}/{assetID}/{from}/{to}/{showTowJourney}?mileageType={mileageType} | 
                 Gets a list of journeys by asset id  | 
        
| GET api/v4/assetjourney/{userID}/{token}/{assetID}/{from}/{to}?showTowJourney={showTowJourney}&mileageType={mileageType} | 
                 Gets a list of journeys by asset id  | 
        
V4AssetJourneySummary
| API | Description | 
|---|---|
| GET api/v4/assetjourneysummary?userID={userID}&token={token}&assetID={assetID}&from={from}&to={to} | 
                 No documentation available.  | 
        
| GET api/v4/assetjourneysummary/{userID}/{token}/{assetID}/{from}/{to} | 
                 No documentation available.  | 
        
V4CanJourney
| API | Description | 
|---|---|
| GET api/v4/canjourney?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to} | 
                 Maps to GetExtendedVehicleCANJourneyData from the V4 web service  | 
        
| GET api/v4/canjourney/{userID}/{token}/{serviceID}/{from}/{to} | 
                 Maps to GetExtendedVehicleCANJourneyData from the V4 web service  | 
        
V4CrashFile
| API | Description | 
|---|---|
| GET api/v4/crashfile?userID={userID}&token={token}&fileKey={fileKey} | 
                 Pull back a crash file using a S3 file key  | 
        
| GET api/v4/crashfile/{userID}/{token}/{fileKey} | 
                 Pull back a crash file using a S3 file key  | 
        
V4CreateUser
| API | Description | 
|---|---|
| POST api/v4/createuser | 
                 No documentation available.  | 
        
V4DetailedGroup
| API | Description | 
|---|---|
| GET api/v4/detailedgroup?userID={userID}&token={token}&groupID={groupID}&childGroups={childGroups}&userIDQueried={userIDQueried} | 
                 Get a list of groups by group id or user id. If using group ID you can specify if you would like to pull back child groups  | 
        
| GET api/v4/detailedgroup/{userID}/{token}/{groupID}/{childGroups}/{userIDQueried} | 
                 Get a list of groups by group id or user id. If using group ID you can specify if you would like to pull back child groups  | 
        
V4DriverScore
| API | Description | 
|---|---|
| GET api/v4/driverscore?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to} | 
                 Maps to GetDriverScore from the V4 web service  | 
        
| GET api/v4/driverscore/{userID}/{token}/{serviceID}/{from}/{to} | 
                 Maps to GetDriverScore from the V4 web service  | 
        
V4FleetScore3Value
| API | Description | 
|---|---|
| GET api/v4/fleetscore3value?userId={userId}&token={token}&serviceId={serviceId}&from={from}&to={to} | 
                 Pull back scores  | 
        
| GET api/v4/fleetscore3value/{userId}/{token}/{serviceId}/{from}/{to}/{score} | 
                 Pull back scores  | 
        
V4Group
| API | Description | 
|---|---|
| GET api/v4/group?userID={userID}&token={token}&groupID={groupID} | 
                 Maps to GetAllGroupsForCurrentViewer from the V4 web service  | 
        
| GET api/v4/group/{userID}/{token}/{groupID} | 
                 Maps to GetAllGroupsForCurrentViewer from the V4 web service  | 
        
V4GroupCrash
| API | Description | 
|---|---|
| GET api/v4/groupcrash?userID={userID}&token={token}&groupID={groupID}&from={from}&to={to} | 
                 Pull back a list of crash events for vehicles in a group  | 
        
| GET api/v4/groupcrash/{userID}/{token}/{groupID}/{from}/{to} | 
                 Pull back a list of crash events for vehicles in a group  | 
        
V4GroupLatestLocation
| API | Description | 
|---|---|
| GET api/v4/grouplatestlocation?userID={userID}&token={token}&groupID={groupID} | 
                 Get a list of locations for a group id  | 
        
| GET api/v4/grouplatestlocation/{userID}/{token}/{groupID} | 
                 Get a list of locations for a group id  | 
        
V4Journey
| API | Description | 
|---|---|
| GET api/v4/journey?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to}&showTowJourney={showTowJourney}&mileageType={mileageType} | 
                 Maps to GetJourneySummaryByVehId from the V4 web service  | 
        
| GET api/v4/journey/{userID}/{token}/{serviceID}/{from}/{to}/{mileageType}?showTowJourney={showTowJourney} | 
                 Maps to GetJourneySummaryByVehId from the V4 web service  | 
        
| GET api/v4/journey/{userID}/{token}/{serviceID}/{from}/{to}/{showTowJourney}/{mileageType} | 
                 Maps to GetJourneySummaryByVehId from the V4 web service  | 
        
| GET api/v4/journey/{userID}/{token}/{serviceID}/{from}/{to}/{showTowJourney}?mileageType={mileageType} | 
                 Maps to GetJourneySummaryByVehId from the V4 web service  | 
        
| GET api/v4/journey/{userID}/{token}/{serviceID}/{from}/{to}?showTowJourney={showTowJourney}&mileageType={mileageType} | 
                 Maps to GetJourneySummaryByVehId from the V4 web service  | 
        
V4JourneySummary
Controller used to get journey summary information. Note times must start at 00:00:00 to ensure the desired start day is covered
| API | Description | 
|---|---|
| GET api/v4/journeysummary?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to} | 
                 Get summarised journey information. Note times must start at 00:00:00 to ensure the desired start day is covered  | 
        
| GET api/v4/journeysummary/{userID}/{token}/{serviceID}/{from}/{to}/{showTowJourney} | 
                 Get summarised journey information. Note times must start at 00:00:00 to ensure the desired start day is covered  | 
        
| POST api/v4/journeysummary | 
                 Get summarised journey information. Note times must start at 00:00:00 to ensure the desired start day is covered  | 
        
V4LatestLocation
| API | Description | 
|---|---|
| GET api/v4/latestlocation?userID={userID}&token={token}&sericeIdList={sericeIdList} | 
                 Get a list of locations for a list of service ids  | 
        
| GET api/v4/latestlocation/{userID}/{token}/{sericeIdList} | 
                 Get a list of locations for a list of service ids  | 
        
| POST api/v4/latestlocation | 
                 Get a list of locations for a list of service ids  | 
        
V4Odometer
| API | Description | 
|---|---|
| POST api/v4/odometer | 
                 Get a list of odometers for multiple services  | 
        
V4PassengerCount
| API | Description | 
|---|---|
| GET api/v4/passengercount?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to} | 
                 Pulls back passenger count records - Maps to V3 GetPassengerCount web service method  | 
        
| GET api/v4/passengercount/{userID}/{token}/{serviceID}/{from}/{to} | 
                 Pulls back passenger count records - Maps to V3 GetPassengerCount web service method  | 
        
V4Service
| API | Description | 
|---|---|
| GET api/v4/service?userID={userID}&token={token}&serviceID={serviceID}&groupID={groupID} | 
                 Get a list of services by service id or group id  | 
        
| GET api/v4/service/{userID}/{token}/{serviceID}/{groupID} | 
                 Get a list of services by service id or group id  | 
        
| GET api/v4/service?userID={userID}&token={token}&imei={imei} | 
                 Get a service by imei  | 
        
| GET api/v4/service/{userID}/{token}/{imei} | 
                 Get a service by imei  | 
        
V4ServiceListJourney
Controller used to get journey summary information from multiple service ids
| API | Description | 
|---|---|
| GET api/v4/servicelistjourney?userID={userID}&token={token}&sericeIdList={sericeIdList}&from={from}&to={to}&mileageType={mileageType} | 
                 Get journeys using a list of service ids  | 
        
| GET api/v4/servicelistjourney/{userID}/{token}/{sericeIdList}/{from}/{to}/{mileageType} | 
                 Get journeys using a list of service ids  | 
        
| GET api/v4/servicelistjourney/{userID}/{token}/{sericeIdList}/{from}/{to}?mileageType={mileageType} | 
                 Get journeys using a list of service ids  | 
        
| POST api/v4/servicelistjourney | 
                 Get journeys using a list of service ids  | 
        
V4ServiceListTelemetry
Controller used to get telemetry from multiple service ids
| API | Description | 
|---|---|
| GET api/v4/servicelisttelemetry?userID={userID}&token={token}&sericeIdList={sericeIdList}&from={from}&to={to}&messageTypeList={messageTypeList} | 
                 Get telemetry using a list of service ids and message types  | 
        
| GET api/v4/servicelisttelemetry/{userID}/{token}/{sericeIdList}/{from}/{to}/{messageTypeList} | 
                 Get telemetry using a list of service ids and message types  | 
        
| GET api/v4/servicelisttelemetry/{userID}/{token}/{sericeIdList}/{from}/{to}?messageTypeList={messageTypeList} | 
                 Get telemetry using a list of service ids and message types  | 
        
| POST api/v4/servicelisttelemetry | 
                 Get telemetry using a list of service ids and message types  | 
        
V4ServiceStatus
| API | Description | 
|---|---|
| GET api/v4/servicestatus?userID={userID}&token={token}&serviceID={serviceID}&groupID={groupID} | 
                 Get a list of service status by service id or group id  | 
        
| GET api/v4/servicestatus/{userID}/{token}/{serviceID}/{groupID} | 
                 Get a list of service status by service id or group id  | 
        
V4ServiceStatusLite
| API | Description | 
|---|---|
| GET api/v4/servicestatuslite?userID={userID}&token={token}&serviceID={serviceID}&groupID={groupID} | 
                 Get a list of lite service statuses by service id or group id  | 
        
| GET api/v4/servicestatuslite/{userID}/{token}/{serviceID}/{groupID} | 
                 Get a list of lite service statuses by service id or group id  | 
        
V4Telem
| API | Description | 
|---|---|
| GET api/v4/telem?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to}&msgType={msgType} | 
                 Maps to getTelemetryData from the V4 web service  | 
        
| GET api/v4/telem/{userID}/{token}/{serviceID}/{from}/{to}/{msgType} | 
                 Maps to getTelemetryData from the V4 web service  | 
        
V4User
| API | Description | 
|---|---|
| GET api/v4/user?userID={userID}&token={token}&userIDQueried={userIDQueried}&groupID={groupID} | 
                 Gets a list of users (viewers) by user id or group id  | 
        
| GET api/v4/user/{userID}/{token}/{userIDQueried}/{groupID} | 
                 Gets a list of users (viewers) by user id or group id  | 
        
V4UserGroups
| API | Description | 
|---|---|
| GET api/v4/usergroups?userID={userID}&token={token}&userIDQueried={userIDQueried} | 
                 Get all groups for a queried user  | 
        
| GET api/v4/usergroups/{userID}/{token}/{userIDQueried} | 
                 Get all groups for a queried user  | 
        
V4UserVehicle
| API | Description | 
|---|---|
| GET api/v4/uservehicle?userID={userID}&token={token} | 
                 No documentation available.  | 
        
| GET api/v4/uservehicle/{userID}/{token} | 
                 No documentation available.  | 
        
V4Vehicle
| API | Description | 
|---|---|
| GET api/v4/vehicle?userID={userID}&token={token}&groupID={groupID} | 
                 Maps to GetVehicleIds and GetVehicleIdsForGroup from the V4 web service  | 
        
| GET api/v4/vehicle/{userID}/{token}/{groupID} | 
                 Maps to GetVehicleIds and GetVehicleIdsForGroup from the V4 web service  | 
        
V4VehicleCanDtc
| API | Description | 
|---|---|
| GET api/v4/vehiclecandtccontroller?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to} | 
                 Pulls back can DTC records - Maps to V3 GetVehicleCanDtcData web service method  | 
        
| GET api/v4/vehiclecandtccontroller/{userID}/{token}/{serviceID}/{from}/{to} | 
                 Pulls back can DTC records - Maps to V3 GetVehicleCanDtcData web service method  | 
        
V5AssetScore
V5VehicleScore
| API | Description | 
|---|---|
| GET api/v5/vehiclescore?userID={userID}&token={token}&serviceIDList={serviceIDList}&scoreType={scoreType}&scorePeriod={scorePeriod}&from={from}&to={to} | 
                 Get vehicle score  | 
        
| GET api/v5/vehiclescore/{userID}/{token}/{serviceIDList}/{scoreType}/{scorePeriod}/{from}/{to} | 
                 Get vehicle score  | 
        
| POST api/v5/vehiclescore | 
                 Get vehicle score  | 
        
V5VehicleScoreMultipleDateRange
| API | Description | 
|---|---|
| POST api/v5/vehiclescoremultipledaterange | 
                 Get vehicle score for multiple date ranges  | 
        
Vehicle
API controller for retrieving vehicle lists
| API | Description | 
|---|---|
| GET api/vehicle?userID={userID}&token={token}&groupID={groupID}&vehicleID={vehicleID} | 
                 Returns the details for either a single vehicle or all vehicles in the supplied group  | 
        
| GET api/vehicle/{userID}/{token}/{groupID}/{vehicleID} | 
                 Returns the details for either a single vehicle or all vehicles in the supplied group  | 
        
VehicleCheck
Send a completed vehicle check
| API | Description | 
|---|---|
| POST api/classe/vehiclecheck | 
                 Send a completed vehicle check  | 
        
VehicleCheckSchema
Get a vehicle check schema
| API | Description | 
|---|---|
| GET api/classe/vehiclecheckschema?driverID={driverID}&token={token}&numericalSchema={numericalSchema} | 
                 Get vehicle check schema using a numerical schema type  | 
        
| GET api/classe/vehiclecheckschema/{driverID}/{token}/{numericalSchema} | 
                 Get vehicle check schema using a numerical schema type  | 
        
| GET api/classe/vehiclecheckschema?driverID={driverID}&token={token}&serviceID={serviceID} | 
                 Get vehicle check schemas for a driver  | 
        
| GET api/classe/vehiclecheckschema/{driverID}/{token}/{serviceID} | 
                 Get vehicle check schemas for a driver  |