360Locate API Help PageAgency
Contains methods for dealing with Agencies.
| API | Description |
|---|---|
| GET Agency |
Get all Agencies. |
| GET Agency/{id} |
Retrieve a single Agency based on id. |
| GET Agency?name={name} |
Retrieve a single Agency based by name. |
| POST Agency |
Create a new Agency. |
| PUT Agency/{id} |
Update an existing Agency. |
| DELETE Agency/{id} |
Delete a Agency based on it's id. |
| DELETE Agency?name={name} |
Delete a Agency based on it's name. |
Asset
Contains methods for dealing with Assets. Asset Controller requires the Token to be passed on to the HTTP Headers. Authorization: Token F+xWYVQ80yK1b3WV2Kkpqmao0vyRrV/OiQbxpFI6Xr2MS1S1DR13OkCn2au3DqqAuBn1PE7vSriwp/GjEOR1lA==
| API | Description |
|---|---|
| GET Group/{id}/Asset |
Retrieve assets by group. |
| POST Asset/{assetId}/Archive/{endDate} |
Archive an Asset. |
| POST Asset/{assetId}/{deviceId}/UnArchive |
UnArchive an Asset. |
| GET Asset/Deactivate?deviceId={deviceId}&clientId={clientId} |
Need help? Assistance is available upon request. |
| GET Asset?includeLocation={includeLocation}&includeArchived={includeArchived}&includeDeviceState={includeDeviceState} |
Get all Assets. |
| GET Asset/{id}?includeLocation={includeLocation} |
Retrieve a single Asset based on id. |
| GET Asset?code={code}&platenumber={platenumber} |
Retrieve a single Asset based on code. |
| POST Asset |
Create one or more new Asset(s). |
| PUT Asset/{id} |
Update an existing Asset. |
| DELETE Asset/{id} |
Delete a Asset based on it's id. |
| DELETE Asset?code={code} |
Delete a Asset based on it's code. |
AssetDriver
AssetDriverController
| API | Description |
|---|---|
| GET AssetDriver |
Get all AssetDrivers. |
| GET AssetDriver?assetId={assetId} |
Get all single AssetDriver. |
| POST AssetDriver |
Insert a new AssetDriver |
| PUT AssetDriver/{id} |
Update an AssetDriver based on it's id. |
| DELETE AssetDriver/{id} |
Delete an AssetDriver based on it's id. |
Calibration
| API | Description |
|---|---|
| GET Asset/{id}/Calibration |
Get calibrations by Asset. |
| GET Device/{id}/Calibration |
Get calibrations by Device. |
| GET Calibration/{id} |
Get single calibration. |
| PUT Calibration/{id} |
Update calibration. |
| POST Calibration |
New calibration. |
| DELETE Calibration |
Delete calibration. |
CheckInOut
Contains methods for dealing with checkin and checkout events for vehicles.
| API | Description |
|---|---|
| GET CheckInOut/{id} |
Retrieve a single event by id. |
| GET CheckInOut?reference={reference} |
Retrieve events by reference. |
| GET CheckInOut?assetid={assetid}&locationid={locationid}&driverid={driverid}&count={count} |
Get all events by Asset, Location and or Driver. |
| GET CheckInOut?driverid={driverid}&locationid={locationid}&lastonly={lastonly} |
Retrieve most recent event per asset filtered on Location and Driver. |
| GET CheckInOut?locationid={locationid} |
Retrieve all CheckInOut based on location. |
| GET CheckInOut?locationid={locationid}&lastonly={lastonly} |
Retrieve most recent event per asset filtered on Location. |
| POST CheckInOut |
Create a new Checkin (or out) event. |
| PUT CheckInOut/{id} |
Update an existing Checkin (or out) event. |
| DELETE CheckInOut/{id} |
Delete a CheckInOut based on it's id. |
| DELETE CheckInOut?reference={reference} |
Delete a CheckInOut based on it's name. |
| DELETE CheckInOut?ids[0]={ids[0]}&ids[1]={ids[1]} |
Deleting a pair of CheckInOut items. |
Client
Contains methods for dealing with Clients. Clients can be seen as the main entity of a User Account.
| API | Description |
|---|---|
| GET Client |
Get all Clients. |
| GET Client/{id} |
Retrieve a single client based on id. |
| GET Client?erpCode={erpCode} |
Retrieve a single client based on erp code. |
| PUT Client/{id} |
Update an existing client. |
DamagePhoto
| API | Description |
|---|---|
| POST DamagePhoto |
Need help? Assistance is available upon request. |
| GET DamagePhoto?cicoid={cicoid}&assetid={assetid} |
Need help? Assistance is available upon request. |
| GET DamagePhoto?damagephotoid={damagephotoid} |
Need help? Assistance is available upon request. |
Department
Contains methods for dealing with Departments.
| API | Description |
|---|---|
| GET Department |
Get all Departments. |
| GET Department/{id} |
Retrieve a single Department based on id. |
| GET Department?name={name} |
Retrieve a single Department based by name. |
| POST Department |
Create a new Department. |
| PUT Department/{id} |
Update an existing Department. |
| DELETE Department/{id} |
Delete a Department based on it's id. |
| DELETE Department?name={name} |
Delete a Department based on it's name. |
Device
Contains methods for dealing with Assets. Asset Controller requires the Token to be passed on to the HTTP Headers. Authorization: Token F+xWYVQ80yK1b3WV2Kkpqmao0vyRrV/OiQbxpFI6Xr2MS1S1DR13OkCn2au3DqqAuBn1PE7vSriwp/GjEOR1lA==
| API | Description |
|---|---|
| GET Device/{id}?includeLocation={includeLocation} |
Get single devices. |
| GET Device/Search?searchTerm={searchTerm}&includeLocation={includeLocation} |
Get single devices. |
| GET Device/{deviceId}/InstallationDetails |
Get installation details of device |
| POST Device/{deviceId}/UpdateInstallationDetails |
Update installation details |
| POST Device/{deviceId}/Add/{assetId} |
Add asset to device. |
| GET Device?includeLocation={includeLocation} |
Get all devices. |
DeviceEpisodeTypeSettings
Contains methods for dealing with Users. Users can be seen as the main entity of a User Account.
| API | Description |
|---|---|
| GET DeviceEpisodeTypeSettings |
Get current user based on token. |
| POST DeviceEpisodeTypeSettings |
Update an existing User. |
Driver
Contains methods for dealing with Drivers.
| API | Description |
|---|---|
| GET DriverGroups?aType={aType}&aParentId={aParentId} |
Get all Driver groups |
| GET DriverClassification?aDriverId={aDriverId} |
Get DriverClassification |
| GET StoreDriverClassification?aDriverId={aDriverId}&aSectorId={aSectorId}&aManagementId={aManagementId}&aDepartmentId={aDepartmentId} |
Store DriverClassification |
| GET Driver |
Get all Drivers. |
| GET Driver/{id} |
Retrieve a single Driver based on id. |
| GET Driver?driverTag={driverTag} |
Retrieve a single Driver based on DriverTag. |
| GET Driver?searchTerm={searchTerm} |
Retrieve a driver based on Last- and or Firstname. |
| POST Driver |
Create a new Driver. |
| PUT Driver/{id} |
Update an existing Driver. |
| PUT Driver?driverTag={driverTag} |
Update an existing Driver. |
| DELETE Driver/{id} |
Delete a Driver based on it's id. |
| DELETE Driver?tag={tag} |
Delete a Driver based on it's tag. |
DriverScoreSummary
| API | Description |
|---|---|
| GET DriverScoreSummary?start={start}&end={end} |
Episode
Return the episodes of a given trip
| API | Description |
|---|---|
| GET Episode/{deviceId}/{start}/{end}/{includeLocationData} |
Get all Episodes for given device. |
| GET Asset/{assetId}/Episodes/{start}/{end}/{types}/{includeLocationData}/{includeRoadPolygon} |
Need help? Assistance is available upon request. |
| GET Asset/{assetId}/Episodes/{start}/{end}/{includeLocationData}/{includeRoadPolygon} |
Need help? Assistance is available upon request. |
| GET Episode/{deviceId}/{start}/{end}/{types}/{includeLocationData}/{includeRoadPolygon} |
Get all Episodes for given device. |
| GET EpisodeById/{assetId}/{episodeId}/{includeLocationData}/{isIdling}/{includeRoadPolygon}?includeRoadPolyon={includeRoadPolyon} |
Get the episode inc locations for a specific episodeid |
| GET User/Episode/{start}/{end} |
Get all Episodes for user. |
| GET User/Episode/{start}/{end}/{types} |
Get all Episodes for user. |
| GET Episode |
ErrorLog
Contains post method for dealing with error-log.
| API | Description |
|---|---|
| POST ErrorLog |
Posts error to log. |
FileUpload
| API | Description |
|---|---|
| POST FileUpload |
Need help? Assistance is available upon request. |
ForwardLocations
Forwards CachedLocations to the local ForwardedLocationsParser. Useful for replicating locations on Live to Staging. See also NotificationDispatcher.
| API | Description |
|---|---|
| POST ForwardLocations |
Garage
Contains methods for dealing with Garages.
| API | Description |
|---|---|
| GET Garage |
Get all Garages. |
| GET Garage/{id} |
Retrieve a single Garage based on id. |
| GET Garage?name={name} |
Retrieve a single Garage based by name. |
| POST Garage |
Create a new Garage. |
| PUT Garage/{id} |
Update an existing Garage. |
| DELETE Garage/{id} |
Delete a Garage based on it's id. |
| DELETE Garage?name={name} |
Delete a Garage based on it's name. |
GeoFence
Contains methods for dealing with GeoFences.
| API | Description |
|---|---|
| GET GeoFence?includeGeoJson={includeGeoJson} |
Get all GeoFences. |
| GET GeoFence/{id} |
Retrieve a single geofence based on id. |
| GET GeoFence?referenceId={referenceId} |
Retrieve a single geofence based on external reference id. |
| POST GeoFence |
Create a new GeoFence. |
| PUT GeoFence/{id} |
Update an existing GeoFence. |
| PUT GeoFence?reference={reference} |
Update an existing GeoFence based on Reference. |
| DELETE GeoFence/{id} |
Delete a GeoFence based on it's id. |
| DELETE GeoFence?reference={reference} |
Delete a GeoFence based on it's external reference id. |
GeoFenceCollection
Contains methods for dealing with collections of GeoFences. This allows you to insert or change a batch of GeoFences in one shot.
| API | Description |
|---|---|
| POST GeoFenceCollection |
Create a one or more new GeoFence(s). |
GeofenceGroup
Contains methods for dealing with Geofence Groups.
| API | Description |
|---|---|
| GET GeofenceGroup |
Get all Groups. |
| GET GeofenceGroup/{id} |
Retrieve a single Group based on id. |
| GET GeofenceGroup?aClientId={aClientId}&aUserId={aUserId}&aGroupId={aGroupId} |
Get the assetgroups for a user |
| POST GeofenceGroup |
Create a new Group. |
| DELETE GeofenceGroup/{id} |
Delete a Group based on it's id. |
GeofenceState
| API | Description |
|---|---|
| GET Asset/{assetid}/GeoFenceStates/{start}/{end} |
Get most recent GeoFenceStates by Asset ID. |
| GET Device/{deviceId}/GeoFenceStates/{start}/{end} |
Get most recent GeoFenceStates by Device ID. |
| GET GeoFenceStates/{geofenceId}/{start}/{end} |
Get most recent GeoFenceStates by Geofence ID. |
GeofenceStateEpisodes
GeofenceStateEpisodes are calculated episodes based on geofencestates.
| API | Description |
|---|---|
| GET Device/{deviceId}/GeofenceStateEpisodes/{start}/{end} |
Get most recent GeofenceStateEpisodes by Device ID. |
Group
Contains methods for dealing with AssetGroups.
| API | Description |
|---|---|
| GET Group?includeDevices={includeDevices}&includeAssets={includeAssets} |
Get all Groups. |
| GET Group/{id} |
Retrieve a single Group based on id. |
| GET Group?aUserId={aUserId}&aGroupId={aGroupId} |
Get the assetgroups for a user |
| POST Group |
Create a new Group. |
| PUT Group/{id} |
Update an existing Group. |
| DELETE Group/{id} |
Delete a AssetGroup based on it's id. |
IO
Contains methods for immobilizing Assets. Controller requires the Token to be passed on to the HTTP Headers. Authorization: Token F+xWYVQ80yK1b3WV2Kkpqmao0vyRrV/OiQbxpFI6Xr2MS1S1DR13OkCn2au3DqqAuBn1PE7vSriwp/GjEOR1lA==
| API | Description |
|---|---|
| GET IO/{id}/ImmobilizeToggle?abort={abort}&immobilize={immobilize} |
(Im)mobilize an assets. |
| GET IO/{id}/Immobilize |
Immobilize an assets. |
| GET IO/{id}/Mobilize |
Mobilize an assets. |
| GET IO/{id}/DoorClose/{durationInMilliseconds} |
Control door closing. |
| GET IO/{id}/DoorOpen/{durationInMilliseconds} |
Control door opening. |
Location
Contains methods for dealing with Locations.
| API | Description |
|---|---|
| GET Location/{previousLookupTimestamp}/All |
Get all Assets. |
| GET LocationStateManager/{previousLookupTimestamp}/All |
Get all Assets. |
| POST Cities |
Get all Assets. |
| GET Device/{id}/Location |
Get most recent locations by device. |
| GET Asset/{id}/Location |
Get most recent locations by Asset. |
| GET Device/{id}/Location/{start}/{end}/{includeAsset} |
Get all locations by Device. |
| GET Asset/{id}/Location/{start}/{end} |
Get all locations by asset. |
Maintenance
Contains methods for dealing with Maintenance. This Controller requires the Token to be passed on to the HTTP Headers. Authorization: Token F+xWYVQ80yK1b3WV2Kkpqmao0vyRrV/OiQbxpFI6Xr2MS1S1DR13OkCn2au3DqqAuBn1PE7vSriwp/GjEOR1lA==
| API | Description |
|---|---|
| GET Asset/{id}/Maintenance |
Get all Maintenances. |
| GET Device/{id}/Maintenance |
Get all Maintenances. |
MaintenanceOccurrence
| API | Description |
|---|---|
| GET MaintenanceOccurrence/{id} |
Need help? Assistance is available upon request. |
| POST MaintenanceOccurrence |
Need help? Assistance is available upon request. |
| PUT MaintenanceOccurrence/{id} |
Need help? Assistance is available upon request. |
MapProvider
| API | Description |
|---|---|
| GET MapProvider |
Get the MapProviders for the current user |
Metrics
Contains methods for fleetoverview dashboard metrics.
| API | Description |
|---|---|
| GET Metrics/Infringements |
Get infringements. |
| POST Metrics/Infringements?fromDate={fromDate}&toDate={toDate} |
Get infringements. |
| GET Metrics/TimeOfDailyUse?fromDate={fromDate}&toDate={toDate} |
Get TimeOfDailyUse. |
| POST Metrics/TimeOfDailyUse?fromDate={fromDate}&toDate={toDate} |
Get TimeOfDailyUse. |
| POST Metrics/Distance?fromDate={fromDate}&toDate={toDate} |
Get Distance. |
| POST Metrics/Sensors?fromDate={fromDate}&toDate={toDate} |
Get Distance. |
| POST Metrics/TargetVsActual?fromDate={fromDate}&toDate={toDate} |
Need help? Assistance is available upon request. |
Notification
Notification Controller class
| API | Description |
|---|---|
| GET Notification/Filtered |
Get |
| GET Notification |
Need help? Assistance is available upon request. |
| GET Notification/{id} |
Need help? Assistance is available upon request. |
Permission
Get information about the permissions set for a user.
| API | Description |
|---|---|
| GET Permission |
Returns list of the enabled permissions for the user. |
Ping
Used for health checks.
| API | Description |
|---|---|
| GET Ping/Health |
Used to monitor healthiness of API. Checks both API availability and database responsiveness. |
| GET Ping |
Used by deploy scripts to check if a website has been deployed (somewhat) successfully. This method is not being used actively, since it is to basic to be used elsewhere, its left for backwards compatibility. Disclaimer: The PowerShell scripts are no longer used, this has been replaced by Azure Pipelines. |
Profile
Contains methods for dealing with Profiles.
| API | Description |
|---|---|
| GET Profile |
Get all Profiles. |
| POST Profile |
Create a new Profile. |
| PUT Profile/{id} |
Update an existing Project. |
| DELETE Profile/{id} |
Delete a Profile based on it's id. |
Project
Contains methods for dealing with Groups.
| API | Description |
|---|---|
| GET Project |
Get all Projects. |
Report
Allows a user to interact with and run reports.
| API | Description |
|---|---|
| GET Report?culture={culture} |
Need help? Assistance is available upon request. |
| GET Report/{reportId}/Parameters?culture={culture} |
Returns the ReportParameters for a report identified with reportId. If no parameters can be found for the given reportId, HttpStatusCode.NotFound is returned. |
| POST Report/{reportId}/Run?reportRunId={reportRunId}&startRowIndex={startRowIndex}&endRowIndexExclusive={endRowIndexExclusive}&culture={culture}&maximumExecutionTimeSeconds={maximumExecutionTimeSeconds} |
Runs the report with the parameters given in the Body. If parameters are invalid this is returned in the ReportRunDetailsRestResult.Errors. The reportRunId is optional, but it is used for optimization. Calls to subsequent pages of the report should be done with the reportRunId. |
Settings
Contains methods for dealing with Users. Users can be seen as the main entity of a User Account.
| API | Description |
|---|---|
| GET Settings |
Get current user based on token. |
| PUT Settings/{id} |
Update an existing User. |
| POST Settings |
Update an existing User. |
Statistics
Statistical data about a vehicle or fleet.
| API | Description |
|---|---|
| GET Statistics?deviceid={deviceid}&start={start}&end={end} |
Get Private/Business mileage statistics for a device. |
| GET Statistics?deviceids[0]={deviceids[0]}&deviceids[1]={deviceids[1]}&start={start}&end={end} |
Get Private/Business mileage statistics for a list of devices. |
| GET Statistics?assetid={assetid}&start={start}&end={end} |
Get Private/Business mileage statistics for a device. |
| GET Statistics |
Get utilization numbers on the whole fleet. |
Stop
Contains methods for dealing with stops for vehicles.
| API | Description |
|---|---|
| GET Device/{id}/Stop/{start}/{end}/{firstLoad}/{includeLocation} |
Get all stops by device. |
| GET Asset/{id}/Stop/{start}/{end}/{firstLoad} |
Get all stops by asset. |
Trips
Retrieve trip history.
| API | Description |
|---|---|
| GET Device/{id}/Trip/{start}/{end}/{firstLoad}/{includeLocation} |
Get all trips by device. |
| GET Trips/GetByDevice?ids[0]={ids[0]}&ids[1]={ids[1]}&start={start}&end={end}&includeLocation={includeLocation} |
Get all trips by list of devices. |
| GET Asset/{id}/Trip/{start}/{end}/{firstLoad}/{includeLocation}/{includeActive} |
Get all trips by asset. |
| GET Driver/{driverId}/Trip/{start}/{end}/{firstLoad}/{includeLocation} |
Get all trips by driver. |
| GET Trips/{id}/{includeLocation} |
Get a single trips by id. |
| GET ActiveTrip/{id}/{includeLocation} |
Get a single trips by id. |
| PUT Trips/{id} |
Update an existing trip. |
| POST Trips/LastTrips |
Update an existing trip. |
User
Contains methods for dealing with Users. Users can be seen as the main entity of a User Account.
| API | Description |
|---|---|
| GET User |
Get current user based on token. |
| GET User/{id} |
Retrieve a single User by id. |
| GET User?username={username} |
Retrieve a single User by username. |
| PUT User/{id} |
Update an existing User. |
UserContact
Controller for UserContacts.
| API | Description |
|---|---|
| POST UserContact/RegisterPushContact |
Register a mobile push contact. |
| POST UserContact/UnregisterPushContact |
Unregister a mobile push contact. |
Wasl
Contains methods for dealing with Groups.
| API | Description |
|---|---|
| GET Asset/Wasl |
Get all Projects. |
| POST Driver/Register?id={id} |
Register driver with WASL. |
| POST Asset/Register?id={id} |
Register asset with WASL. |