Ctrack Maxx API  4.0.4.257
API for ctrack
Public Member Functions | List of all members
DCT.CtrackExternalAPI.Service.TrackingUnit Class Reference

Service for actions and information relating to tracking units; such as mapping, trip and incident information. More...

Inheritance diagram for DCT.CtrackExternalAPI.Service.TrackingUnit:

Public Member Functions

List< VehicleMappingGetVehicleMappingsByVehicleRegistrations (string token, string[] vehicleregs)
 This function retrieves basic details about the vehicle associated with a tracking unit using the vehicle registration; via SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingGetVehicleMappingsByVehicleRegistrationsRest (string token, string vehicleregs)
 This function retrieves basic details about the vehicle associated with a tracking unit using the vehicle registration; via REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingExtendedGetVehicleMappingsByVehicleRegistrationsExtended (string token, string[] vehicleregs)
 This function retrieves extended details about the vehicle associated with a tracking unit using the vehicle registration; via SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingExtendedGetVehicleMappingsByVehicleRegistrationsExtendedRest (string token, string vehicleregs)
 This function retrieves basic details about the vehicle associated with a tracking unit using the vehicle registration; via REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingGetVehicleMappingsBySerialNumbers (string token, string[] serialnumbers)
 This function retrieves basic details about the vehicle associated with a tracking unit using the unit serial number; via SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingGetVehicleMappingsBySerialNumbersRest (string token, string serialnumbers)
 This function retrieves basic details about the vehicle associated with a tracking unit using the unit serial number; via REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingExtendedGetVehicleMappingsBySerialNumbersExtended (string token, string[] serialnumbers)
 This function retrieves extended details about the vehicle associated with a tracking unit using the unit serial number; via SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingExtendedGetVehicleMappingsBySerialNumbersExtendedRest (string token, string serialnumbers)
 This function retrieves extended details about the vehicle associated with a tracking unit using the unit serial number; via REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingExtendedGetVehicleMappingsByVinNumbers (string token, string[] vinnumbers)
 This function retrieves extended details about the vehicle associated with a tracking unit using the VIN recorded in MaXx; via SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleMappingExtendedGetVehicleMappingsByVinNumbersRest (string token, string vinnumbers)
 This function retrieves extended details about the vehicle associated with a tracking unit using the VIN recorded in MaXx; via REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleDetailsGetVehicleDetailsByIds (string token, string vehicleids)
 This function retrieves a list of vehicle details using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleDetailsGetVehicleDetailsByIdsRest (string token, string vehicleids)
 This function retrieves a list of vehicle details using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< EngineerVehicleSummaryGetEngineerVehicleSummary (string token, string vehicleIds)
 This function provides information typically used during installation of a tracking unit within a vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour More...
 
List< EngineerVehicleSummaryGetEngineerVehicleSummaryRest (string token, string vehicleIds)
 This function provides information typically used during installation of a tracking unit within a vehicle using REST.

Bespoke Call, Max 60 Calls per Hour More...
 
List< VehicleStateGetVehicleStatesById (string token, string vehicleids, string datetime)
 Gets a list of historical (or current) vehicle states. Using SOAP

Advanced Call, Max 60 Calls per Hour More...
 
List< VehicleStateGetVehicleStatesByIdRest (string token, string vehicleids, string datetime)
 Gets a list of historical (or current) vehicle states. Using REST

Standard Call, Max 60 Calls per Hour More...
 
List< VehicleStateGetLatestVehicleStatesById (string token, string vehicleids)
 Gets the latest available status report for a vehicle or set of vehicles. Using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleStateGetLatestVehicleStatesByIdRest (string token, string vehicleids)
 Gets the latest available status report for a vehicle or set of vehicles. Using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehiclePositionAndDriverDetailsGetAllVehiclePositionsAndDriversInfoCitrix (string token)
 This function retrieves the latest available status report for all vehicles visible to the caller (including driver information), using SOAP.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< VehiclePositionAndDriverDetailsGetAllVehiclePositionsAndDriversInfoCitrixRest (string token)
 This function retrieves the latest available status report for all vehicles visible to the caller (including driver information), using REST.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< TripSummaryGetTripSummaryById (string token, int vehicleid, string startdatetime, string enddatetime)
 This function retrieves a list of trips for a vehicle, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< TripSummaryGetTripSummaryByIdRest (string token, string vehicleid, string startdatetime, string enddatetime)
 This function retrieves a list of trips for a vehicle, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< TripSummaryExtendedGetTripSummaryExtended (int unitnodeid, string startdatetime, string enddatetime, string token, string cultureinfo)
 This function retrieves a list of trips for a vehicle with extended data, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< TripSummaryExtendedGetTripSummaryExtendedRest (string unitnodeid, string startdatetime, string enddatetime, string token, string cultureinfo)
 This function retrieves a list of trips for a vehicle with extended data, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< FullTripSummaryGetFullTripSummary (string startdatetime, string enddatetime, string token, string vehicleIds)
 This function retrieves a list of trips for a vehicle with extended data, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< FullTripSummaryGetFullTripSummaryRest (string startdatetime, string enddatetime, string token, string vehicleIds)
 This function retrieves a list of trips for a vehicle with extended data, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< BusinessPrivateFullTripSummaryGetBusinessPrivateFullTripSummary (string startdatetime, string enddatetime, string token, string vehicleIds)
 This function retrieves a list of trips for a vehicle with extended data, using SOAP. Trips with the Private flag set return partial or no data in the following response fields (alternatively, the field may not be present in the SOAP response): More...
 
List< BusinessPrivateFullTripSummaryGetBusinessPrivateFullTripSummaryRest (string startdatetime, string enddatetime, string token, string vehicleIds)
 This function retrieves a list of trips for a vehicle with extended data, using REST. Trips with the Private flag set return partial or no data in the following response fields (alternatively, the field may not be present in the JSON response): More...
 
List< TripPositionGetTripPositionById (string token, int vehicleid, string startdatetime, string enddatetime)
 This function retrieves a list of trip positions for a vehicle, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< TripPositionGetTripPositionByIdRest (string token, string vehicleid, string startdatetime, string enddatetime)
 This function retrieves a list of trip positions for a vehicle, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< TripPositionExtendedGetFullTripPositions (string token, string vehicleIds, string startDateTime, string endDateTime)
 This function retrieves a list of trip positions for the specified vehicles between the specified start and end times, using SOAP.

Advanced Call, Max 3600 Calls per Hour More...
 
List< TripPositionExtendedGetFullTripPositionsRest (string token, string vehicleIds, string startDateTime, string endDateTime)
 This function retrieves a list of trip positions for the specified vehicles between the specified start and end times, using REST.

Advanced Call, Max 3600 Calls per Hour More...
 
List< VehicleCurrentRunningDataGetVehicleCurrentRunningDataByIds (string token, string vehicleids)
 This function retrieves current running data for the selected vehicles, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleCurrentRunningDataGetVehicleCurrentRunningDataByIdsRest (string token, string vehicleids)
 This function retrieves current running data for the selected vehicles, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
VehicleDriverCurrentAssignment GetVehicleDriverCurrentAssignment (string token, int vehicleid)
 This function retrieves information about the driver assignment status of the specified vehicle, using SOAP.

Standard Call, Max 60 Calls per Hour More...
 
VehicleDriverCurrentAssignment GetVehicleDriverCurrentAssignmentRest (string token, string vehicleid)
 This function retrieves information about the driver assignment status of the specified vehicle, using REST.

Standard Call, Max 60 Calls per Hour More...
 
Count GetAlarmCountByDateRange (string token, string startdatetime, string enddatetime)
 This function retrieves the number of alarms that occurred within a date range, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
Count GetAlarmCountByDateRangeRest (string token, string startdatetime, string enddatetime)
 This function retrieves the number of alarms that occurred within a date range, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< AlertDetailsGetAlarmDetailsByDateRange (string token, string startdatetime, string enddatetime)
 This function retrieves the details of any alarms that occurred between the specified date range, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< AlertDetailsGetAlarmDetailsByDateRangeRest (string token, string startdatetime, string enddatetime)
 This function retrieves the details of any alarms that occurred between the specified date range, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleProfileGetVehicleProfiles (string token, int vehicleid)
 This function retrieves the profiles available for assignment to a vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour More...
 
List< VehicleProfileGetVehicleProfilesRest (string token, string vehicleid)
 This function retrieves the profiles available for assignment to a vehicle, using REST.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse SaveVehicleDetail (string token, VehicleDetails vehicledetails)
 This function updates a vehicle's details using SOAP.

Bespoke Call, Max 60 Calls per Hour More...
 
UpdateResponse SaveVehicleDetailRest (string token, string vehicleid, string vehicleregistration, string fleetnumber, string vehicledescription, string vehiclemake, string vehiclemodel, string vehiclecolour, string vehiclevinnumber, string enginenumber, string odometer, string vehiclehours, string profileid, string serialnumber)
 This function updates a vehicle's details using REST.

Bespoke Call, Max 60 Calls per Hour More...
 
UpdateResponse FinaliseVehicleById (string token, int vehicleid)
 This function queues a vehicle for remote finalisation using SOAP.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse FinaliseVehicleByIdRest (string token, string vehicleid)
 This function queues a vehicle for remote finalisation using REST.

Advanced Call, Max 60 Calls per Hour More...
 
VehicleOdo GetVehicleOdometerByIdAndDatetime (string token, int vehicleid, string datetime)
 This function retrieves an odometer value (in meters) for a vehicle at a specific date and time, using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
VehicleOdo GetVehicleOdometerByIdAndDatetimeRest (string token, string vehicleid, string datetime)
 This function retrieves an odometer value (in meters) for a vehicle at a specific date and time, using REST.

Standard Call, Max 3600 Calls per Hour More...
 
List< VehicleOdoDriftCorrectionsGetVehicleOdoDriftCorrectionsByVehicleID (string token, int vehicleid)
 This function returns a list of odometer drift corrections for the specified vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour More...
 
List< VehicleOdoDriftCorrectionsGetVehicleOdoDriftCorrectionsByVehicleIDRest (string token, string vehicleid)
 This function returns a list of odometer drift corrections for the specified vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour More...
 
List< VehicleLockStateGetVehicleCurrentLockStatusByVehicleID (string token, int[] vehicleids)
 This function returns a list of current vehicle states, including the lock status of the vehicle; using SOAP.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< VehicleLockStateGetVehicleCurrentLockStatusByVehicleIDRest (string token, string vehicleids)
 This function returns a list of current vehicle states, including the lock status of the vehicle; using REST.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< EventPositionGetListStatusEventsByVehicleIDAndDateRange (string token, int vehicleid, int StatusType, string StartDateTime, string EndDateTime)
 This function returns a list of positions associated with specific categories of event. Data may be filtered by vehicle, date range and event type; using SOAP.

Standard Call, Max 3600 Calls per Hour More...
 
List< EventPositionGetListStatusEventsByVehicleIDAndDateRangeRest (string token, string vehicleid, string StatusType, string StartDateTime, string EndDateTime)
 This function returns a list of positions associated with specific categories of event. Data may be filtered by vehicle, date range and event type; using REST.

Standard Call, Max 3600 Calls per Hour More...
 
UpdateResponse SetVehicleLockStatusByVehicleID (string token, int vehicleid, bool lockstate)
 This function allows locking or unlocking of a vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour More...
 
UpdateResponse SetVehicleLockStatusByVehicleIDRest (string token, string vehicleid, string lockstate)
 This function allows locking or unlocking of a vehicle using REST.

Bespoke Call, Max 60 Calls per Hour More...
 
List< VehicleIncidentDetailsGetIncidentDataByVehicleIDAtDateTime (string token, int vehicleid, string IncidentDate, int SecondsPre, int SecondsPost)
 This function retrieves detailed information on a specific vehicle incident using SOAP.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< VehicleIncidentDetailsGetIncidentDataByVehicleIDAtDateTimeRest (string token, string vehicleid, string IncidentDate, string SecondsPre, string SecondsPost)
 This function retrieves detailed information on a specific vehicle incident using REST.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< CustomFieldsGetVehicleCustomFieldsByVehicleID (string token, int VehicleID)
 This function retrieves the names and values of custom fields set for a vehicle in MaXx using SOAP.

Advanced Call, Max 60 Calls per Hour More...
 
List< CustomFieldsGetVehicleCustomFieldsByVehicleIDRest (string token, string VehicleID)
 This function retrieves the names and values of custom fields set for a vehicle in MaXx using REST.

Advanced Call, Max 60 Calls per Hour More...
 
List< EventPositionGetIncidentEventPositionsByDateTimeRange (string token, int vehicleid, string StartDateTime, string EndDateTime)
 This function provides basic information about vehicle incidents recorded during the specified time period using SOAP.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< EventPositionGetIncidentEventPositionsByDateTimeRangeRest (string token, string vehicleid, string StartDateTime, string EndDateTime)
 This function provides basic information about vehicle incidents recorded during the specified time period using REST.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< MILDTCTripDataGetEngineFaultCodes (string token, string startDateTime, string endDateTime, string vehicleIds)
 This function gets a MIL (Malfunction Indicator Lamp) and DTC (Diagnostic Trouble Code) summary report for a vehicle or all vehicles using SOAP.

Bespoke Call, Max 3600 Calls per Hour More...
 
List< MILDTCTripDataGetEngineFaultCodesRest (string token, string startDateTime, string endDateTime, string vehicleIds)
 This function a MIL (Malfunction Indicator Lamp) and DTC (Diagnostic Trouble Code) summary report for a vehicle or all of vehicles using REST.

Bespoke Call, Max 3600 Calls per Hour More...
 
UpdateResponse AssignCostCentreToVehicle (string token, int vehicleID, int OwningCostCentreID, int[] CostCentres)
 This function allows adding a vehicle to one or many cost centres, including setting the primary (owning) cost centre; using SOAP.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse AssignCostCentreToVehicleRest (string token, string vehicleID, string OwningCostCentreID, string CostCentres)
 This function allows adding a vehicle to one or many cost centres, including setting the primary (owning) cost centre; using REST.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse ImmobiliseVehicleByVehicleID (string token, int vehicleID)
 This function allows an immobilisation request to be sent to MaXx for the specified vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse ImmobiliseVehicleByVehicleIDRest (string token, string vehicleID)
 This function allows an immobilisation request to be sent to MaXx for the specified vehicle, using REST.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse MobiliseVehicleByVehicleID (string token, int vehicleID)
 This function allows a mobilisation request to be sent to MaXx for the specified vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse MobiliseVehicleByVehicleIDRest (string token, string vehicleID)
 This function allows a mobilisation request to be sent to MaXx for the specified vehicle, using REST.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse AssignProfileToVehicleById (int vehicleId, int profileId, string token)
 This function allows assignment of a specific profile to a vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour More...
 
UpdateResponse AssignProfileToVehicleByIdRest (int vehicleId, int profileId, string token)
 This function allows assignment of a specific profile to a vehicle, using REST.

Advanced Call, Max 60 Calls per Hour More...
 

Detailed Description

Service for actions and information relating to tracking units; such as mapping, trip and incident information.

Member Function Documentation

◆ AssignCostCentreToVehicle()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.AssignCostCentreToVehicle ( string  token,
int  vehicleID,
int  OwningCostCentreID,
int[]  CostCentres 
)
inline

This function allows adding a vehicle to one or many cost centres, including setting the primary (owning) cost centre; using SOAP.

Advanced Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleIDA numerical vehicle ID.
OwningCostCentreIDThe numerical ID of the intended owning cost centre.
CostCentresAn array of cost centres within which the vehicle should be visible. Must include the owning cost centre.
Returns
An UpdateResponse.

◆ AssignCostCentreToVehicleRest()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.AssignCostCentreToVehicleRest ( string  token,
string  vehicleID,
string  OwningCostCentreID,
string  CostCentres 
)
inline

This function allows adding a vehicle to one or many cost centres, including setting the primary (owning) cost centre; using REST.

Advanced Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleIDA numerical vehicle ID.
OwningCostCentreIDThe numerical ID of the intended owning cost centre.
CostCentresAn array of cost centres within which the vehicle should be visible. Must include the owning cost centre.
Returns
An UpdateResponse.

◆ AssignProfileToVehicleById()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.AssignProfileToVehicleById ( int  vehicleId,
int  profileId,
string  token 
)
inline

This function allows assignment of a specific profile to a vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour

The set of profiles available for assignment is dependent upon the owning cost centre for the vehicle.

Exceptions

Parameters
profileIdProfile Id
tokenA valid security token.
vehicleIdA numerical vehicle ID.
Returns
An UpdateResponse.

◆ AssignProfileToVehicleByIdRest()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.AssignProfileToVehicleByIdRest ( int  vehicleId,
int  profileId,
string  token 
)
inline

This function allows assignment of a specific profile to a vehicle, using REST.

Advanced Call, Max 60 Calls per Hour

The set of profiles available for assignment is dependent upon the owning cost centre for the vehicle.

Exceptions

Parameters
profileIdProfile Id
tokenA valid security token.
vehicleIdA numerical vehicle ID.
Returns
An UpdateResponse.

◆ FinaliseVehicleById()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.FinaliseVehicleById ( string  token,
int  vehicleid 
)
inline

This function queues a vehicle for remote finalisation using SOAP.

Advanced Call, Max 60 Calls per Hour

Finalisation causes the unit to reset and re-orient its sensors so that orientation, movement and g-forces etc. are more accurately recorded.
This should be done during installation, with the vehicle stationary and level.

Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical ID of the vehicle to finalise.
Returns
An UpdateResponse .

◆ FinaliseVehicleByIdRest()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.FinaliseVehicleByIdRest ( string  token,
string  vehicleid 
)
inline

This function queues a vehicle for remote finalisation using REST.

Advanced Call, Max 60 Calls per Hour

Finalisation causes the unit to reset and re-orient its sensors so that orientation, movement and g-forces etc. are more accurately recorded.
This should be done during installation, with the vehicle stationary and level.

Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical ID of the vehicle to finalise.
Returns
An UpdateResponse .

◆ GetAlarmCountByDateRange()

Count DCT.CtrackExternalAPI.Service.TrackingUnit.GetAlarmCountByDateRange ( string  token,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves the number of alarms that occurred within a date range, using SOAP.

Standard Call, Max 3600 Calls per Hour

This is for a maximum of 48 hours.

Exceptions

Parameters
tokenA valid security token.
startdatetimeStart Date/Time
enddatetimeEnd Date/Time
Returns
A Count object.

◆ GetAlarmCountByDateRangeRest()

Count DCT.CtrackExternalAPI.Service.TrackingUnit.GetAlarmCountByDateRangeRest ( string  token,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves the number of alarms that occurred within a date range, using REST.

Standard Call, Max 3600 Calls per Hour

This is for a maximum of 48 hours.

Exceptions

Parameters
tokenA valid security token.
startdatetimeStart Date/Time
enddatetimeEnd Date/Time
Returns
A Count object.

◆ GetAlarmDetailsByDateRange()

List<AlertDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetAlarmDetailsByDateRange ( string  token,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves the details of any alarms that occurred between the specified date range, using SOAP.

Standard Call, Max 3600 Calls per Hour

This is for a maximum of 48 hours

Exceptions

Parameters
tokenA valid security token.
startdatetimeStart Date Time.
enddatetimeEnd Date Time.
Returns
A list of AlertDetails objects.

◆ GetAlarmDetailsByDateRangeRest()

List<AlertDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetAlarmDetailsByDateRangeRest ( string  token,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves the details of any alarms that occurred between the specified date range, using REST.

Standard Call, Max 3600 Calls per Hour

This is for a maximum of 48 hours.

Exceptions

Parameters
tokenA valid security token.
startdatetimeStart Date Time
enddatetimeEnd Date Time
Returns
A list of AlertDetails objects.

◆ GetAllVehiclePositionsAndDriversInfoCitrix()

List<VehiclePositionAndDriverDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetAllVehiclePositionsAndDriversInfoCitrix ( string  token)
inline

This function retrieves the latest available status report for all vehicles visible to the caller (including driver information), using SOAP.

Bespoke Call, Max 3600 Calls per Hour

Exceptions

Parameters
tokenA valid security token.
Returns
A list of VehiclePositionAndDriverDetails objects.

◆ GetAllVehiclePositionsAndDriversInfoCitrixRest()

List<VehiclePositionAndDriverDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetAllVehiclePositionsAndDriversInfoCitrixRest ( string  token)
inline

This function retrieves the latest available status report for all vehicles visible to the caller (including driver information), using REST.

Bespoke Call, Max 3600 Calls per Hour

Exceptions

Parameters
tokenA valid security token.
Returns
A list of VehiclePositionAndDriverDetails objects.

◆ GetBusinessPrivateFullTripSummary()

List<BusinessPrivateFullTripSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetBusinessPrivateFullTripSummary ( string  startdatetime,
string  enddatetime,
string  token,
string  vehicleIds 
)
inline

This function retrieves a list of trips for a vehicle with extended data, using SOAP. Trips with the Private flag set return partial or no data in the following response fields (alternatively, the field may not be present in the SOAP response):

  • StartDateTime : Date only
  • StartLatitude : null
  • StartLongitude : null
  • StartLocation: Empty

  • StopDateTime : Date only
  • StopLatitude : null
  • StopLongitude : null
  • StopLocation: Empty



Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters. This is for a maximum of 48 hours.
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsComma seperated list of vehicle IDs.
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of BusinessPrivateFullTripSummary objects.

◆ GetBusinessPrivateFullTripSummaryRest()

List<BusinessPrivateFullTripSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetBusinessPrivateFullTripSummaryRest ( string  startdatetime,
string  enddatetime,
string  token,
string  vehicleIds 
)
inline

This function retrieves a list of trips for a vehicle with extended data, using REST. Trips with the Private flag set return partial or no data in the following response fields (alternatively, the field may not be present in the JSON response):

  • StartDateTime : Date only
  • StartLatitude : null
  • StartLongitude : null
  • StartLocation: Empty

  • StopDateTime : Date only
  • StopLatitude : null
  • StopLongitude : null
  • StopLocation: Empty



Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters. This is for a maximum of 48 hours.
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsComma seperated list of vehicle IDs.
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of BusinessPrivateFullTripSummary objects.

◆ GetEngineerVehicleSummary()

List<EngineerVehicleSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetEngineerVehicleSummary ( string  token,
string  vehicleIds 
)
inline

This function provides information typically used during installation of a tracking unit within a vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleIdsA comma-delimited list of vehicle ID's.
Returns
An EngineerVehicleSummary object.

◆ GetEngineerVehicleSummaryRest()

List<EngineerVehicleSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetEngineerVehicleSummaryRest ( string  token,
string  vehicleIds 
)
inline

This function provides information typically used during installation of a tracking unit within a vehicle using REST.

Bespoke Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleIdsA comma-delimited list of vehicle ID's
Returns
An EngineerVehicleSummary object.

◆ GetEngineFaultCodes()

List<MILDTCTripData> DCT.CtrackExternalAPI.Service.TrackingUnit.GetEngineFaultCodes ( string  token,
string  startDateTime,
string  endDateTime,
string  vehicleIds 
)
inline

This function gets a MIL (Malfunction Indicator Lamp) and DTC (Diagnostic Trouble Code) summary report for a vehicle or all vehicles using SOAP.

Bespoke Call, Max 3600 Calls per Hour

A period of up to 48 hours may be searched at once.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsThe numeric vehicle ID, set to 0 to retrieve data for all vehicles.
startDateTimeStart of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
endDateTimeEnd of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
Returns
A list of MILDTCTripData objects.

◆ GetEngineFaultCodesRest()

List<MILDTCTripData> DCT.CtrackExternalAPI.Service.TrackingUnit.GetEngineFaultCodesRest ( string  token,
string  startDateTime,
string  endDateTime,
string  vehicleIds 
)
inline

This function a MIL (Malfunction Indicator Lamp) and DTC (Diagnostic Trouble Code) summary report for a vehicle or all of vehicles using REST.

Bespoke Call, Max 3600 Calls per Hour

A period of up to 48 hours may be searched at once.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsThe numeric vehicle ID, set to 0 to retrieve data for all vehicles.
startDateTimeStart of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
endDateTimeEnd of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
Returns
A list of MILDTCTripData objects.

◆ GetFullTripPositions()

List<TripPositionExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetFullTripPositions ( string  token,
string  vehicleIds,
string  startDateTime,
string  endDateTime 
)
inline

This function retrieves a list of trip positions for the specified vehicles between the specified start and end times, using SOAP.

Advanced Call, Max 3600 Calls per Hour

The start and end times are subject to the following limits:

  • Two hours of data can be retrieved for up to 50 vehicles at once.
  • For queries covering more than 50 vehicles, fifteen minutes of data can be retrieved at once.

In addition, odometer values (e.g. RunningOdo) will not be returned on newly installed vehicles until after the first Sunday following the installation.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsA comma-separated list of vehicle ID's.
startDateTimeDate/Time for the start of the trip summary.
endDateTimeDate/Time for the end of the trip summary.
Returns
A list of TripPositionExtended objects.

◆ GetFullTripPositionsRest()

List<TripPositionExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetFullTripPositionsRest ( string  token,
string  vehicleIds,
string  startDateTime,
string  endDateTime 
)
inline

This function retrieves a list of trip positions for the specified vehicles between the specified start and end times, using REST.

Advanced Call, Max 3600 Calls per Hour

The start and end times are subject to the following limits:

  • Two hours of data can be retrieved for up to 50 vehicles at once.
  • For queries covering more than 50 vehicles, fifteen minutes of data can be retrieved at once.

In addition, odometer values (e.g. RunningOdo) will not be returned on newly installed vehicles until after the first Sunday following the installation.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsA comma-separated list of vehicle ID's.
startDateTimeDate/Time for the start of the trip summary.
endDateTimeDate/Time for the end of the trip summary.
Returns
A list of TripPositionExtended objects.

◆ GetFullTripSummary()

List<FullTripSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetFullTripSummary ( string  startdatetime,
string  enddatetime,
string  token,
string  vehicleIds 
)
inline

This function retrieves a list of trips for a vehicle with extended data, using SOAP.

Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters. This is for a maximum of 48 hours.
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsComma seperated list of vehicle IDs.
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of FullTripSummary objects.

◆ GetFullTripSummaryRest()

List<FullTripSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetFullTripSummaryRest ( string  startdatetime,
string  enddatetime,
string  token,
string  vehicleIds 
)
inline

This function retrieves a list of trips for a vehicle with extended data, using REST.

Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters. This is for a maximum of 48 hours.
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
vehicleIdsComma seperated list of vehicle IDs.
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of FullTripSummary objects.

◆ GetIncidentDataByVehicleIDAtDateTime()

List<VehicleIncidentDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetIncidentDataByVehicleIDAtDateTime ( string  token,
int  vehicleid,
string  IncidentDate,
int  SecondsPre,
int  SecondsPost 
)
inline

This function retrieves detailed information on a specific vehicle incident using SOAP.

Bespoke Call, Max 3600 Calls per Hour

An incident is recorded when a unit experiences abnormal levels of g-force that may indicate a serious event.
This function is intended to be used in conjuction with GetIncidentEventPositionsByDateTimeRange.

  • Only supported for NX55 units.
  • Incident must have been uploaded to FTP site.



Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
IncidentDateDateTime of the incident. Needs to be accurate to the minute.
SecondsPreFilter to apply to returned data before the Incident Date, in seconds. Values less than 1 = no filter.
SecondsPostFilter to apply to returned data after the Incident Date, in seconds. Values less than 1 = no filter.
Returns
A list of VehicleIncidentDetails objects.

◆ GetIncidentDataByVehicleIDAtDateTimeRest()

List<VehicleIncidentDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetIncidentDataByVehicleIDAtDateTimeRest ( string  token,
string  vehicleid,
string  IncidentDate,
string  SecondsPre,
string  SecondsPost 
)
inline

This function retrieves detailed information on a specific vehicle incident using REST.

Bespoke Call, Max 3600 Calls per Hour

An incident is recorded when a unit experiences abnormal levels of g-force that may indicate a serious event.
This function is intended to be used in conjuction with GetIncidentEventPositionsByDateTimeRangeRest.

  • Only supported for NX55 units.
  • Incident must have been uploaded to FTP site.



Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
IncidentDateDateTime of the incident. Needs to be accurate to the minute.
SecondsPreFilter to apply to returned data before the Incident Date, in seconds. Values less than 1 = no filter.
SecondsPostFilter to apply to returned data after the Incident Date, in seconds. Values less than 1 = no filter.
Returns
A list of VehicleIncidentDetails objects.

◆ GetIncidentEventPositionsByDateTimeRange()

List<EventPosition> DCT.CtrackExternalAPI.Service.TrackingUnit.GetIncidentEventPositionsByDateTimeRange ( string  token,
int  vehicleid,
string  StartDateTime,
string  EndDateTime 
)
inline

This function provides basic information about vehicle incidents recorded during the specified time period using SOAP.

Bespoke Call, Max 3600 Calls per Hour

This function is intended to be used in conjuction with GetIncidentDataByVehicleIDAtDateTime.
A period of up to 48 hours may be searched for a single vehicle, or 4 hours for all vehicles.

Exceptions

Parameters
tokenA valid security token.
vehicleidThe numeric vehicle ID, set to 0 to retrieve data for all vehicles.
StartDateTimeStart of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
EndDateTimeEnd of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
Returns
A list of EventPosition objects.

◆ GetIncidentEventPositionsByDateTimeRangeRest()

List<EventPosition> DCT.CtrackExternalAPI.Service.TrackingUnit.GetIncidentEventPositionsByDateTimeRangeRest ( string  token,
string  vehicleid,
string  StartDateTime,
string  EndDateTime 
)
inline

This function provides basic information about vehicle incidents recorded during the specified time period using REST.

Bespoke Call, Max 3600 Calls per Hour

This function is intended to be used in conjuction with GetIncidentDataByVehicleIDAtDateTimeRest.
A period of up to 48 hours may be searched for a single vehicle, or 4 hours for all vehicles.

Exceptions

Parameters
tokenA valid security token.
vehicleidThe numeric vehicle ID, set to 0 to retrieve data for all vehicles.
StartDateTimeStart of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
EndDateTimeEnd of the search period. The filter is based upon the date and time data was recieved (not when it occurred).
Returns
A list of EventPosition objects.

◆ GetLatestVehicleStatesById()

List<VehicleState> DCT.CtrackExternalAPI.Service.TrackingUnit.GetLatestVehicleStatesById ( string  token,
string  vehicleids 
)
inline

Gets the latest available status report for a vehicle or set of vehicles. Using SOAP.

Standard Call, Max 3600 Calls per Hour

Exceptions

Parameters
tokenA valid security token.
vehicleidsA comma-seperated list of vehicle ID's.
Returns
A list of VehicleState objects.

◆ GetLatestVehicleStatesByIdRest()

List<VehicleState> DCT.CtrackExternalAPI.Service.TrackingUnit.GetLatestVehicleStatesByIdRest ( string  token,
string  vehicleids 
)
inline

Gets the latest available status report for a vehicle or set of vehicles. Using REST.

Standard Call, Max 3600 Calls per Hour

Exceptions

Parameters
tokenA valid security token.
vehicleidsA comma-seperated list of vehicle ID's.
Returns
A list of VehicleState objects.

◆ GetListStatusEventsByVehicleIDAndDateRange()

List<EventPosition> DCT.CtrackExternalAPI.Service.TrackingUnit.GetListStatusEventsByVehicleIDAndDateRange ( string  token,
int  vehicleid,
int  StatusType,
string  StartDateTime,
string  EndDateTime 
)
inline

This function returns a list of positions associated with specific categories of event. Data may be filtered by vehicle, date range and event type; using SOAP.

Standard Call, Max 3600 Calls per Hour

This is for a maximum of 48 hours at a time.

Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
StatusType
  1. Business/Private Switch
  2. Ignition On/Off
  3. Harsh Events
  4. Speeding Events
  5. Idling Events
  6. In/Out Waypoint
StartDateTimeDate/Time for the start of the search period.
EndDateTimeDate/Time for the end of the search period.
Returns
A list of EventPosition objects.

◆ GetListStatusEventsByVehicleIDAndDateRangeRest()

List<EventPosition> DCT.CtrackExternalAPI.Service.TrackingUnit.GetListStatusEventsByVehicleIDAndDateRangeRest ( string  token,
string  vehicleid,
string  StatusType,
string  StartDateTime,
string  EndDateTime 
)
inline

This function returns a list of positions associated with specific categories of event. Data may be filtered by vehicle, date range and event type; using REST.

Standard Call, Max 3600 Calls per Hour

This is for a maximum of 48 hours at a time.

Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
StatusType
  1. Business/Private Switch
  2. Ignition On/Off
  3. Harsh Events
  4. Speeding Events
  5. Idling Events
  6. In/Out Waypoint
StartDateTimeDate/Time for the start of the search period.
EndDateTimeDate/Time for the end of the search period.
Returns
A list of EventPosition objects.

◆ GetTripPositionById()

List<TripPosition> DCT.CtrackExternalAPI.Service.TrackingUnit.GetTripPositionById ( string  token,
int  vehicleid,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves a list of trip positions for a vehicle, using SOAP.

Standard Call, Max 3600 Calls per Hour

This will return a list of trip position that were made during the start/end dates specified in the parameters.
This is for a maximum of 48 hours.

Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of TripPosition objects.

◆ GetTripPositionByIdRest()

List<TripPosition> DCT.CtrackExternalAPI.Service.TrackingUnit.GetTripPositionByIdRest ( string  token,
string  vehicleid,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves a list of trip positions for a vehicle, using REST.

Standard Call, Max 3600 Calls per Hour

This will return a list of trip position that were made during the start/end dates specified in the parameters.
This is for a maximum of 48 hours.

Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of TripPosition objects.

◆ GetTripSummaryById()

List<TripSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetTripSummaryById ( string  token,
int  vehicleid,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves a list of trips for a vehicle, using SOAP.

Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters (up to 48 hours.)
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
vehicleidvehicle id
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of TripSummary objects.

◆ GetTripSummaryByIdRest()

List<TripSummary> DCT.CtrackExternalAPI.Service.TrackingUnit.GetTripSummaryByIdRest ( string  token,
string  vehicleid,
string  startdatetime,
string  enddatetime 
)
inline

This function retrieves a list of trips for a vehicle, using REST.

Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters (up to 48 hours.)
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
vehicleidvehicle id
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
Returns
A list of TripSummary objects.

◆ GetTripSummaryExtended()

List<TripSummaryExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetTripSummaryExtended ( int  unitnodeid,
string  startdatetime,
string  enddatetime,
string  token,
string  cultureinfo 
)
inline

This function retrieves a list of trips for a vehicle with extended data, using SOAP.

Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters.
This is for a maximum of 48 hours.
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
unitnodeidvehicle id
startdatetimeDate/Time for the start of the trip summary
enddatetimeDate/Time for the end of the trip summary
cultureinfoThe culture data as defined in IETF Language Tags.
Returns
A list of TripSummaryExtended objects.

◆ GetTripSummaryExtendedRest()

List<TripSummaryExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetTripSummaryExtendedRest ( string  unitnodeid,
string  startdatetime,
string  enddatetime,
string  token,
string  cultureinfo 
)
inline

This function retrieves a list of trips for a vehicle with extended data, using REST.

Standard Call, Max 3600 Calls per Hour

This will return a list of trips that were made during the start/end dates specified in the parameters.
This is for a maximum of 48 hours.
Trips falling partially within the period are returned.

Exceptions

Parameters
tokenA valid security token.
unitnodeidA numerical vehicle ID.
startdatetimeDate/Time for the start of the trip summary.
enddatetimeDate/Time for the end of the trip summary.
cultureinfoThe culture data as defined in IETF Language Tags.
Returns
A list of TripSummaryExtended objects.

◆ GetVehicleCurrentLockStatusByVehicleID()

List<VehicleLockState> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleCurrentLockStatusByVehicleID ( string  token,
int[]  vehicleids 
)
inline

This function returns a list of current vehicle states, including the lock status of the vehicle; using SOAP.

Bespoke Call, Max 3600 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidsA comma-separated list of vehicle ID's.
Returns
A list of VehicleLockState objects.

◆ GetVehicleCurrentLockStatusByVehicleIDRest()

List<VehicleLockState> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleCurrentLockStatusByVehicleIDRest ( string  token,
string  vehicleids 
)
inline

This function returns a list of current vehicle states, including the lock status of the vehicle; using REST.

Bespoke Call, Max 3600 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidsA comma-separated list of vehicle ID's.
Returns
A list of VehicleLockState objects.

◆ GetVehicleCurrentRunningDataByIds()

List<VehicleCurrentRunningData> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleCurrentRunningDataByIds ( string  token,
string  vehicleids 
)
inline

This function retrieves current running data for the selected vehicles, using SOAP.

Standard Call, Max 3600 Calls per Hour

The running data contains cumulative information which continuously updates as the vehicle makes trips. If no vehicles are specified, nothing will be returned. Exceptions

Parameters
tokenA valid security token.
vehicleidsA string of comma-seperated vehicle IDs.
Returns
A list of VehicleCurrentRunningData objects.

◆ GetVehicleCurrentRunningDataByIdsRest()

List<VehicleCurrentRunningData> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleCurrentRunningDataByIdsRest ( string  token,
string  vehicleids 
)
inline

This function retrieves current running data for the selected vehicles, using REST.

Standard Call, Max 3600 Calls per Hour

The running data contains cumulative information which continuously updates as the vehicle makes trips. If no vehicles are specified, nothing will be returned. Exceptions

Parameters
tokenA valid security token.
vehicleidsA string of comma-seperated vehicle IDs.
Returns
A list of VehicleCurrentRunningData objects.

◆ GetVehicleCustomFieldsByVehicleID()

List<CustomFields> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleCustomFieldsByVehicleID ( string  token,
int  VehicleID 
)
inline

This function retrieves the names and values of custom fields set for a vehicle in MaXx using SOAP.

Advanced Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
VehicleIDA numerical vehicle ID.
Returns
A list of CustomFields objects.

◆ GetVehicleCustomFieldsByVehicleIDRest()

List<CustomFields> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleCustomFieldsByVehicleIDRest ( string  token,
string  VehicleID 
)
inline

This function retrieves the names and values of custom fields set for a vehicle in MaXx using REST.

Advanced Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
VehicleIDA numerical vehicle ID.
Returns
A list of CustomFields objects.

◆ GetVehicleDetailsByIds()

List<VehicleDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleDetailsByIds ( string  token,
string  vehicleids 
)
inline

This function retrieves a list of vehicle details using SOAP.

Standard Call, Max 3600 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidsA comma-seperated list of vehicle ID's
Returns
A list of VehicleDetails objects.

◆ GetVehicleDetailsByIdsRest()

List<VehicleDetails> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleDetailsByIdsRest ( string  token,
string  vehicleids 
)
inline

This function retrieves a list of vehicle details using REST.

Standard Call, Max 3600 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidsA comma-seperated list of vehicle IDs
Returns
A list of VehicleDetails objects.

◆ GetVehicleDriverCurrentAssignment()

VehicleDriverCurrentAssignment DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleDriverCurrentAssignment ( string  token,
int  vehicleid 
)
inline

This function retrieves information about the driver assignment status of the specified vehicle, using SOAP.

Standard Call, Max 60 Calls per Hour

Gets the current vehicle driver assignment. Returns 0 if there is no currrent assigned driver. Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
Returns
A VehicleDriverCurrentAssignment object.

◆ GetVehicleDriverCurrentAssignmentRest()

VehicleDriverCurrentAssignment DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleDriverCurrentAssignmentRest ( string  token,
string  vehicleid 
)
inline

This function retrieves information about the driver assignment status of the specified vehicle, using REST.

Standard Call, Max 60 Calls per Hour

Gets the current vehicle driver assignment. Returns 0 if there is no currrent assigned driver. Exceptions

Parameters
tokenA valid security token.
vehicleidA numerical vehicle ID.
Returns
A VehicleDriverCurrentAssignment object.

◆ GetVehicleMappingsBySerialNumbers()

List<VehicleMapping> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsBySerialNumbers ( string  token,
string[]  serialnumbers 
)
inline

This function retrieves basic details about the vehicle associated with a tracking unit using the unit serial number; via SOAP.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the serial numbers parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
serialnumbersA string array of serial numbers.

An example of a string array in a raw SOAP request:

<tem:token>5fafff8d-5b26-457c-8c91-e5dcf6c02821</tem:token>
<tem:serialnumbers>
<arr:string>E0024CA5230D306F</arr:string>
<arr:string>E0024CDB85CB552A</arr:string>
<arr:string>E0024CDB85D45A47</arr:string>
</tem:serialnumbers>
Returns
A list of VehicleMapping objects.

◆ GetVehicleMappingsBySerialNumbersExtended()

List<VehicleMappingExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsBySerialNumbersExtended ( string  token,
string[]  serialnumbers 
)
inline

This function retrieves extended details about the vehicle associated with a tracking unit using the unit serial number; via SOAP.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the serial numbers parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
serialnumbersA string array of serial numbers.

An example of a string array in a raw SOAP request:

<tem:token>5fafff8d-5b26-457c-8c91-e5dcf6c02821</tem:token>
<tem:serialnumbers>
<arr:string>E0024CA5230D306F</arr:string>
<arr:string>E0024CDB85CB552A</arr:string>
<arr:string>E0024CDB85D45A47</arr:string>
</tem:serialnumbers>
Returns
A list of VehicleMappingExtended objects.

◆ GetVehicleMappingsBySerialNumbersExtendedRest()

List<VehicleMappingExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsBySerialNumbersExtendedRest ( string  token,
string  serialnumbers 
)
inline

This function retrieves extended details about the vehicle associated with a tracking unit using the unit serial number; via REST.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the serial numbers parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
serialnumbersA comma-delimited list of serial numbers.

An example of a serial number list in a REST request:

E0024CA5230D306F,E0024CDB85CB552A,E0024CDB85D45A47


Returns
A list of VehicleMappingExtended objects.

◆ GetVehicleMappingsBySerialNumbersRest()

List<VehicleMapping> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsBySerialNumbersRest ( string  token,
string  serialnumbers 
)
inline

This function retrieves basic details about the vehicle associated with a tracking unit using the unit serial number; via REST.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the serial numbers parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
serialnumbersA comma-delimited list of serial numbers.

An example of a serial number list in a REST request:

E0024CA5230D306F,E0024CDB85CB552A,E0024CDB85D45A47


Returns
A list of VehicleMapping objects.

◆ GetVehicleMappingsByVehicleRegistrations()

List<VehicleMapping> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVehicleRegistrations ( string  token,
string[]  vehicleregs 
)
inline

This function retrieves basic details about the vehicle associated with a tracking unit using the vehicle registration; via SOAP.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the vehicleregs parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
vehicleregsA string array of registration numbers.

An example of a string array in a raw SOAP request:

<tem:token>d5305b67-ba02-4d9e-a6d9-fddc9b1c6d1a</tem:token>
<tem:vehicleRegs>
<arr:string>YC65 KYG</arr:string>
<arr:string>KU63HVY</arr:string>
<arr:string>YP07GZG [DE]</arr:string>
</tem:vehicleRegs>
Returns
A list of VehicleMapping objects.

◆ GetVehicleMappingsByVehicleRegistrationsExtended()

List<VehicleMappingExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVehicleRegistrationsExtended ( string  token,
string[]  vehicleregs 
)
inline

This function retrieves extended details about the vehicle associated with a tracking unit using the vehicle registration; via SOAP.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the vehicleregs parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
vehicleregsA string array of registration numbers.

An example of a string array in a raw SOAP request:

<tem:token>d5305b67-ba02-4d9e-a6d9-fddc9b1c6d1a</tem:token>
<tem:vehicleRegs>
<arr:string>YC65 KYG</arr:string>
<arr:string>KU63HVY</arr:string>
<arr:string>YP07GZG [DE]</arr:string>
</tem:vehicleRegs>
Returns
A list of VehicleMappingExtended objects.

◆ GetVehicleMappingsByVehicleRegistrationsExtendedRest()

List<VehicleMappingExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVehicleRegistrationsExtendedRest ( string  token,
string  vehicleregs 
)
inline

This function retrieves basic details about the vehicle associated with a tracking unit using the vehicle registration; via REST.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the vehicleregs parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
vehicleregsA string array of registration numbers.

An example of a registration list in a REST request:

YC65 KYG,KU63HVY,YP07GZG [DE]
Returns
A list of VehicleMappingExtended objects.

◆ GetVehicleMappingsByVehicleRegistrationsRest()

List<VehicleMapping> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVehicleRegistrationsRest ( string  token,
string  vehicleregs 
)
inline

This function retrieves basic details about the vehicle associated with a tracking unit using the vehicle registration; via REST.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the vehicleregs parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
vehicleregsA string array of registration numbers.

An example of a registration list in a REST request:

YC65 KYG,KU63HVY,YP07GZG [DE]
Returns
A list of VehicleMapping objects.

◆ GetVehicleMappingsByVinNumbers()

List<VehicleMappingExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVinNumbers ( string  token,
string[]  vinnumbers 
)
inline

This function retrieves extended details about the vehicle associated with a tracking unit using the VIN recorded in MaXx; via SOAP.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the serial numbers parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
vinnumbersA comma-delimited list of VIN's.
Returns
A list of VehicleMappingExtended objects.

◆ GetVehicleMappingsByVinNumbersRest()

List<VehicleMappingExtended> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVinNumbersRest ( string  token,
string  vinnumbers 
)
inline

This function retrieves extended details about the vehicle associated with a tracking unit using the VIN recorded in MaXx; via REST.

Standard Call, Max 3600 Calls per Hour

The intended use of this function is to supply consumers of the service with data that they can use to link vehicles in the Ctrack system to vehicles in their own system. All other functions in the API accept a list of unit id numbers so it is vital that these mappings are correct. We also return some other identifying information for the vehicles (like Fleet Number) which can be used to aid in accurate mapping. If an empty array is passed as the serial numbers parameter, the system will return all relevant vehicles for the user.

Exceptions

Parameters
tokenA valid security token.
vinnumbersA comma-delimited list of VIN's.
Returns
A list of VehicleMappingExtended objects.

◆ GetVehicleOdoDriftCorrectionsByVehicleID()

List<VehicleOdoDriftCorrections> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleOdoDriftCorrectionsByVehicleID ( string  token,
int  vehicleid 
)
inline

This function returns a list of odometer drift corrections for the specified vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical ID of the vehicle.
Returns
A list of VehicleOdoDriftCorrections objects.

◆ GetVehicleOdoDriftCorrectionsByVehicleIDRest()

List<VehicleOdoDriftCorrections> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleOdoDriftCorrectionsByVehicleIDRest ( string  token,
string  vehicleid 
)
inline

This function returns a list of odometer drift corrections for the specified vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical ID of the vehicle.
Returns
A list of VehicleOdoDriftCorrections objects.

◆ GetVehicleOdometerByIdAndDatetime()

VehicleOdo DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleOdometerByIdAndDatetime ( string  token,
int  vehicleid,
string  datetime 
)
inline

This function retrieves an odometer value (in meters) for a vehicle at a specific date and time, using SOAP.

Standard Call, Max 3600 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical vehicle ID.
datetimeThe date and time desired.
Returns
A VehicleOdo object.

◆ GetVehicleOdometerByIdAndDatetimeRest()

VehicleOdo DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleOdometerByIdAndDatetimeRest ( string  token,
string  vehicleid,
string  datetime 
)
inline

This function retrieves an odometer value (in meters) for a vehicle at a specific date and time, using REST.

Standard Call, Max 3600 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical vehicle ID.
datetimeThe date and time desired.
Returns
A VehicleOdo object.

◆ GetVehicleProfiles()

List<VehicleProfile> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleProfiles ( string  token,
int  vehicleid 
)
inline

This function retrieves the profiles available for assignment to a vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidThe vehicle's numerical ID
Returns
A list of VehicleProfile objects.

◆ GetVehicleProfilesRest()

List<VehicleProfile> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleProfilesRest ( string  token,
string  vehicleid 
)
inline

This function retrieves the profiles available for assignment to a vehicle, using REST.

Advanced Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidThe vehicle's numerical ID
Returns
A list of VehicleProfile objects.

◆ GetVehicleStatesById()

List<VehicleState> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleStatesById ( string  token,
string  vehicleids,
string  datetime 
)
inline

Gets a list of historical (or current) vehicle states. Using SOAP

Advanced Call, Max 60 Calls per Hour

The date/time supplied to this function will be used to find the most recent positional data that exists before it.
This can be used to get the most recent vehicles postion when a date/time of 'now' is supplied, or it can be used to get historical data. Larger Fleet calls may have performance implications.

Exceptions

Parameters
tokenA valid security token.
vehicleidsComma seperated list of vehicle IDs
datetimeDate/Time of the historical position (YYYY-MM-DD HH:MM:SS)
Returns
A list of VehicleState objects.

◆ GetVehicleStatesByIdRest()

List<VehicleState> DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleStatesByIdRest ( string  token,
string  vehicleids,
string  datetime 
)
inline

Gets a list of historical (or current) vehicle states. Using REST

Standard Call, Max 60 Calls per Hour

The date/time supplied to this function will be used to find the most recent positional data that exists before it.
This can be used to get the most recent vehicles postion when a date/time of 'now' is supplied, or it can be used to get historical data. Larger Fleet calls my have performance implications.

Exceptions

Parameters
tokenA valid security token.
vehicleidsComma seperated list of vehicle IDs
datetimeDate/Time of the historical position (YYYY-MM-DD HH:MM:SS)
Returns
A list of VehicleState objects.

◆ ImmobiliseVehicleByVehicleID()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.ImmobiliseVehicleByVehicleID ( string  token,
int  vehicleID 
)
inline

This function allows an immobilisation request to be sent to MaXx for the specified vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour

Specific hardware and configuration prerequisites must be met for this function to have an effect upon the target vehicle.

Exceptions

Parameters
tokenA valid security token.
vehicleIDA numerical vehicle ID.
Returns
An UpdateResponse.

◆ ImmobiliseVehicleByVehicleIDRest()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.ImmobiliseVehicleByVehicleIDRest ( string  token,
string  vehicleID 
)
inline

This function allows an immobilisation request to be sent to MaXx for the specified vehicle, using REST.

Advanced Call, Max 60 Calls per Hour

Specific hardware and configuration prerequisites must be met for this function to have an effect upon the target vehicle.

Exceptions

Parameters
tokenA valid security token.
vehicleIDA numerical vehicle ID.
Returns
An UpdateResponse.

◆ MobiliseVehicleByVehicleID()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.MobiliseVehicleByVehicleID ( string  token,
int  vehicleID 
)
inline

This function allows a mobilisation request to be sent to MaXx for the specified vehicle, using SOAP.

Advanced Call, Max 60 Calls per Hour

Specific hardware and configuration prerequisites must be met for this function to have an effect upon the target vehicle.

Exceptions

Parameters
tokenA valid security token.
vehicleIDA numerical vehicle ID.
Returns
An UpdateResponse.

◆ MobiliseVehicleByVehicleIDRest()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.MobiliseVehicleByVehicleIDRest ( string  token,
string  vehicleID 
)
inline

This function allows a mobilisation request to be sent to MaXx for the specified vehicle, using REST.

Advanced Call, Max 60 Calls per Hour

Specific hardware and configuration prerequisites must be met for this function to have an effect upon the target vehicle.

Exceptions

Parameters
tokenA valid security token.
vehicleIDA numerical vehicle ID.
Returns
An UpdateResponse.

◆ SaveVehicleDetail()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.SaveVehicleDetail ( string  token,
VehicleDetails  vehicledetails 
)
inline

This function updates a vehicle's details using SOAP.

Bespoke Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicledetailsA VehicleDetails object.
Returns
An UpdateResponse object.

◆ SaveVehicleDetailRest()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.SaveVehicleDetailRest ( string  token,
string  vehicleid,
string  vehicleregistration,
string  fleetnumber,
string  vehicledescription,
string  vehiclemake,
string  vehiclemodel,
string  vehiclecolour,
string  vehiclevinnumber,
string  enginenumber,
string  odometer,
string  vehiclehours,
string  profileid,
string  serialnumber 
)
inline

This function updates a vehicle's details using REST.

Bespoke Call, Max 60 Calls per Hour



Exceptions

Parameters
tokenA valid security token.
vehicleidThe vehicleid for the details being saved/updated (readonly)
vehicleregistrationThe vehicle registration number, max length 20
fleetnumberThis is a free text field, used for grouping, max length 20
vehicledescriptionThis is a free text field, used for vehicle description, max length 50
vehiclemakeThis is a free text field, used for vehicle make, max length 50
vehiclemodelThis is a free text field, used for vehicle Model, max length 50
vehiclecolourThis is a free text field, used for vehicle Colour, max length 50
vehiclevinnumberThis is a free text field, used for the Vehicle Identification (VIN) number, max length 50
enginenumberThis is a free text field, used for Vehicle Engine Number, max length 50
odometerThis is used to record the vehicle mileage. The value must be sent in meters.
vehiclehoursThis is used to record the vehicle running hours. The value may be overwritten and is specified in seconds.
profileidThe profile ID to assign.
serialnumberThe serial number of the unit (readonly)
Returns
An UpdateResponse.

◆ SetVehicleLockStatusByVehicleID()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.SetVehicleLockStatusByVehicleID ( string  token,
int  vehicleid,
bool  lockstate 
)
inline

This function allows locking or unlocking of a vehicle using SOAP.

Bespoke Call, Max 60 Calls per Hour

This functionality is limited to certain unit types and requires the correct hardware to be installed.

Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical ID of the vehicle.
lockstateTrue/False boolean value to either lock or unlock (True = lock , False = unlock)
Returns
An UpdateResponse.

◆ SetVehicleLockStatusByVehicleIDRest()

UpdateResponse DCT.CtrackExternalAPI.Service.TrackingUnit.SetVehicleLockStatusByVehicleIDRest ( string  token,
string  vehicleid,
string  lockstate 
)
inline

This function allows locking or unlocking of a vehicle using REST.

Bespoke Call, Max 60 Calls per Hour

This functionality is limited to certain unit types and requires the correct hardware to be installed.

Exceptions

Parameters
tokenA valid security token.
vehicleidThe numerical vehicle ID.
lockstateTrue/False boolean value to either lock or unlock (True = lock , False = unlock)
Returns
An UpdateResponse.
DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVehicleRegistrations
List< VehicleMapping > GetVehicleMappingsByVehicleRegistrations(string token, string[] vehicleregs)
This function retrieves basic details about the vehicle associated with a tracking unit using the veh...
Definition: TrackingUnit.svc.cs:69
DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsBySerialNumbersExtended
List< VehicleMappingExtended > GetVehicleMappingsBySerialNumbersExtended(string token, string[] serialnumbers)
This function retrieves extended details about the vehicle associated with a tracking unit using the ...
Definition: TrackingUnit.svc.cs:393
DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsBySerialNumbers
List< VehicleMapping > GetVehicleMappingsBySerialNumbers(string token, string[] serialnumbers)
This function retrieves basic details about the vehicle associated with a tracking unit using the uni...
Definition: TrackingUnit.svc.cs:283
DCT.CtrackExternalAPI.Service.TrackingUnit.GetVehicleMappingsByVehicleRegistrationsExtended
List< VehicleMappingExtended > GetVehicleMappingsByVehicleRegistrationsExtended(string token, string[] vehicleregs)
This function retrieves extended details about the vehicle associated with a tracking unit using the ...
Definition: TrackingUnit.svc.cs:178