Ctrack Maxx API
4.0.4.257
API for ctrack
|
Service for actions and information relating to tracking units; such as mapping, trip and incident information. More...
Public Member Functions | |
List< VehicleMapping > | GetVehicleMappingsByVehicleRegistrations (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< VehicleMapping > | GetVehicleMappingsByVehicleRegistrationsRest (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< VehicleMappingExtended > | GetVehicleMappingsByVehicleRegistrationsExtended (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< VehicleMappingExtended > | GetVehicleMappingsByVehicleRegistrationsExtendedRest (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< VehicleMapping > | GetVehicleMappingsBySerialNumbers (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< VehicleMapping > | GetVehicleMappingsBySerialNumbersRest (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< VehicleMappingExtended > | GetVehicleMappingsBySerialNumbersExtended (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< VehicleMappingExtended > | GetVehicleMappingsBySerialNumbersExtendedRest (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< VehicleMappingExtended > | GetVehicleMappingsByVinNumbers (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< VehicleMappingExtended > | GetVehicleMappingsByVinNumbersRest (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< VehicleDetails > | GetVehicleDetailsByIds (string token, string vehicleids) |
This function retrieves a list of vehicle details using SOAP. Standard Call, Max 3600 Calls per Hour More... | |
List< VehicleDetails > | GetVehicleDetailsByIdsRest (string token, string vehicleids) |
This function retrieves a list of vehicle details using REST. Standard Call, Max 3600 Calls per Hour More... | |
List< EngineerVehicleSummary > | GetEngineerVehicleSummary (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< EngineerVehicleSummary > | GetEngineerVehicleSummaryRest (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< VehicleState > | GetVehicleStatesById (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< VehicleState > | GetVehicleStatesByIdRest (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< VehicleState > | GetLatestVehicleStatesById (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< VehicleState > | GetLatestVehicleStatesByIdRest (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< VehiclePositionAndDriverDetails > | GetAllVehiclePositionsAndDriversInfoCitrix (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< VehiclePositionAndDriverDetails > | GetAllVehiclePositionsAndDriversInfoCitrixRest (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< TripSummary > | GetTripSummaryById (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< TripSummary > | GetTripSummaryByIdRest (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< TripSummaryExtended > | GetTripSummaryExtended (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< TripSummaryExtended > | GetTripSummaryExtendedRest (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< FullTripSummary > | GetFullTripSummary (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< FullTripSummary > | GetFullTripSummaryRest (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< BusinessPrivateFullTripSummary > | GetBusinessPrivateFullTripSummary (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< BusinessPrivateFullTripSummary > | GetBusinessPrivateFullTripSummaryRest (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< TripPosition > | GetTripPositionById (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< TripPosition > | GetTripPositionByIdRest (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< TripPositionExtended > | GetFullTripPositions (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< TripPositionExtended > | GetFullTripPositionsRest (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< VehicleCurrentRunningData > | GetVehicleCurrentRunningDataByIds (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< VehicleCurrentRunningData > | GetVehicleCurrentRunningDataByIdsRest (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< AlertDetails > | GetAlarmDetailsByDateRange (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< AlertDetails > | GetAlarmDetailsByDateRangeRest (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< VehicleProfile > | GetVehicleProfiles (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< VehicleProfile > | GetVehicleProfilesRest (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< VehicleOdoDriftCorrections > | GetVehicleOdoDriftCorrectionsByVehicleID (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< VehicleOdoDriftCorrections > | GetVehicleOdoDriftCorrectionsByVehicleIDRest (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< VehicleLockState > | GetVehicleCurrentLockStatusByVehicleID (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< VehicleLockState > | GetVehicleCurrentLockStatusByVehicleIDRest (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< EventPosition > | GetListStatusEventsByVehicleIDAndDateRange (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< EventPosition > | GetListStatusEventsByVehicleIDAndDateRangeRest (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< VehicleIncidentDetails > | GetIncidentDataByVehicleIDAtDateTime (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< VehicleIncidentDetails > | GetIncidentDataByVehicleIDAtDateTimeRest (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< CustomFields > | GetVehicleCustomFieldsByVehicleID (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< CustomFields > | GetVehicleCustomFieldsByVehicleIDRest (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< EventPosition > | GetIncidentEventPositionsByDateTimeRange (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< EventPosition > | GetIncidentEventPositionsByDateTimeRangeRest (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< MILDTCTripData > | GetEngineFaultCodes (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< MILDTCTripData > | GetEngineFaultCodesRest (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... | |
Service for actions and information relating to tracking units; such as mapping, trip and incident information.
|
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
token | A valid security token. |
vehicleID | A numerical vehicle ID. |
OwningCostCentreID | The numerical ID of the intended owning cost centre. |
CostCentres | An array of cost centres within which the vehicle should be visible. Must include the owning cost centre. |
|
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
token | A valid security token. |
vehicleID | A numerical vehicle ID. |
OwningCostCentreID | The numerical ID of the intended owning cost centre. |
CostCentres | An array of cost centres within which the vehicle should be visible. Must include the owning cost centre. |
|
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
profileId | Profile Id |
token | A valid security token. |
vehicleId | A numerical vehicle ID. |
|
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
profileId | Profile Id |
token | A valid security token. |
vehicleId | A numerical vehicle ID. |
|
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
token | A valid security token. |
vehicleid | The numerical ID of the vehicle to finalise. |
|
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
token | A valid security token. |
vehicleid | The numerical ID of the vehicle to finalise. |
|
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
token | A valid security token. |
startdatetime | Start Date/Time |
enddatetime | End Date/Time |
|
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
token | A valid security token. |
startdatetime | Start Date/Time |
enddatetime | End Date/Time |
|
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
token | A valid security token. |
startdatetime | Start Date Time. |
enddatetime | End Date Time. |
|
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
token | A valid security token. |
startdatetime | Start Date Time |
enddatetime | End Date Time |
|
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
token | A valid security 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
token | A valid security token. |
|
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):
StartLocation: 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
token | A valid security token. |
vehicleIds | Comma seperated list of vehicle IDs. |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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):
StartLocation: 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
token | A valid security token. |
vehicleIds | Comma seperated list of vehicle IDs. |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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
token | A valid security token. |
vehicleIds | A comma-delimited list of vehicle ID's. |
|
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
token | A valid security token. |
vehicleIds | A comma-delimited list of vehicle ID's |
|
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
token | A valid security token. |
vehicleIds | The numeric vehicle ID, set to 0 to retrieve data for all vehicles. |
startDateTime | Start of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
endDateTime | End of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
|
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
token | A valid security token. |
vehicleIds | The numeric vehicle ID, set to 0 to retrieve data for all vehicles. |
startDateTime | Start of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
endDateTime | End of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
|
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:
In addition, odometer values (e.g. RunningOdo) will not be returned on newly installed vehicles until after the first Sunday following the installation.
Exceptions
token | A valid security token. |
vehicleIds | A comma-separated list of vehicle ID's. |
startDateTime | Date/Time for the start of the trip summary. |
endDateTime | Date/Time for the end of the trip summary. |
|
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:
In addition, odometer values (e.g. RunningOdo) will not be returned on newly installed vehicles until after the first Sunday following the installation.
Exceptions
token | A valid security token. |
vehicleIds | A comma-separated list of vehicle ID's. |
startDateTime | Date/Time for the start of the trip summary. |
endDateTime | Date/Time for the end of the trip summary. |
|
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
token | A valid security token. |
vehicleIds | Comma seperated list of vehicle IDs. |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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
token | A valid security token. |
vehicleIds | Comma seperated list of vehicle IDs. |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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.
Exceptions
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
IncidentDate | DateTime of the incident. Needs to be accurate to the minute. |
SecondsPre | Filter to apply to returned data before the Incident Date, in seconds. Values less than 1 = no filter. |
SecondsPost | Filter to apply to returned data after the Incident Date, in seconds. Values less than 1 = no filter. |
|
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.
Exceptions
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
IncidentDate | DateTime of the incident. Needs to be accurate to the minute. |
SecondsPre | Filter to apply to returned data before the Incident Date, in seconds. Values less than 1 = no filter. |
SecondsPost | Filter to apply to returned data after the Incident Date, in seconds. Values less than 1 = no filter. |
|
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
token | A valid security token. |
vehicleid | The numeric vehicle ID, set to 0 to retrieve data for all vehicles. |
StartDateTime | Start of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
EndDateTime | End of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
|
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
token | A valid security token. |
vehicleid | The numeric vehicle ID, set to 0 to retrieve data for all vehicles. |
StartDateTime | Start of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
EndDateTime | End of the search period. The filter is based upon the date and time data was recieved (not when it occurred). |
|
inline |
Gets the latest available status report for a vehicle or set of vehicles. Using SOAP.
Standard Call, Max 3600 Calls per Hour
Exceptions
token | A valid security token. |
vehicleids | A comma-seperated list of vehicle ID's. |
|
inline |
Gets the latest available status report for a vehicle or set of vehicles. Using REST.
Standard Call, Max 3600 Calls per Hour
Exceptions
token | A valid security token. |
vehicleids | A comma-seperated list of vehicle ID's. |
|
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
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
StatusType |
|
StartDateTime | Date/Time for the start of the search period. |
EndDateTime | Date/Time for the end of the search period. |
|
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
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
StatusType |
|
StartDateTime | Date/Time for the start of the search period. |
EndDateTime | Date/Time for the end of the search period. |
|
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
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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
token | A valid security token. |
vehicleid | vehicle id |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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
token | A valid security token. |
vehicleid | vehicle id |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
|
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
token | A valid security token. |
unitnodeid | vehicle id |
startdatetime | Date/Time for the start of the trip summary |
enddatetime | Date/Time for the end of the trip summary |
cultureinfo | The culture data as defined in IETF Language Tags. |
|
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
token | A valid security token. |
unitnodeid | A numerical vehicle ID. |
startdatetime | Date/Time for the start of the trip summary. |
enddatetime | Date/Time for the end of the trip summary. |
cultureinfo | The culture data as defined in IETF Language Tags. |
|
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
token | A valid security token. |
vehicleids | A comma-separated list of vehicle ID's. |
|
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
token | A valid security token. |
vehicleids | A comma-separated list of vehicle ID's. |
|
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
token | A valid security token. |
vehicleids | A string of comma-seperated vehicle IDs. |
|
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
token | A valid security token. |
vehicleids | A string of comma-seperated vehicle IDs. |
|
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
token | A valid security token. |
VehicleID | A numerical vehicle ID. |
|
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
token | A valid security token. |
VehicleID | A numerical vehicle ID. |
|
inline |
This function retrieves a list of vehicle details using SOAP.
Standard Call, Max 3600 Calls per Hour
Exceptions
token | A valid security token. |
vehicleids | A comma-seperated list of vehicle ID's |
|
inline |
This function retrieves a list of vehicle details using REST.
Standard Call, Max 3600 Calls per Hour
Exceptions
token | A valid security token. |
vehicleids | A comma-seperated list of vehicle IDs |
|
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
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
|
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
token | A valid security token. |
vehicleid | A numerical vehicle ID. |
|
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
token | A valid security token. |
serialnumbers | A string array of serial numbers. |
An example of a string array in a raw SOAP request:
|
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
token | A valid security token. |
serialnumbers | A string array of serial numbers. |
An example of a string array in a raw SOAP request:
|
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
token | A valid security token. |
serialnumbers | A comma-delimited list of serial numbers. |
An example of a serial number list in a REST request:
|
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
token | A valid security token. |
serialnumbers | A comma-delimited list of serial numbers. |
An example of a serial number list in a REST request:
|
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
token | A valid security token. |
vehicleregs | A string array of registration numbers. |
An example of a string array in a raw SOAP request:
|
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
token | A valid security token. |
vehicleregs | A string array of registration numbers. |
An example of a string array in a raw SOAP request:
|
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
token | A valid security token. |
vehicleregs | A string array of registration numbers. |
An example of a registration list in a REST request:
|
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
token | A valid security token. |
vehicleregs | A string array of registration numbers. |
An example of a registration list in a REST request:
|
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
token | A valid security token. |
vinnumbers | A comma-delimited list of VIN's. |
|
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
token | A valid security token. |
vinnumbers | A comma-delimited list of VIN's. |
|
inline |
This function returns a list of odometer drift corrections for the specified vehicle using SOAP.
Bespoke Call, Max 60 Calls per Hour
Exceptions
token | A valid security token. |
vehicleid | The numerical ID of the vehicle. |
|
inline |
This function returns a list of odometer drift corrections for the specified vehicle using SOAP.
Bespoke Call, Max 60 Calls per Hour
Exceptions
token | A valid security token. |
vehicleid | The numerical ID of the vehicle. |
|
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
token | A valid security token. |
vehicleid | The numerical vehicle ID. |
datetime | The date and time desired. |
|
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
token | A valid security token. |
vehicleid | The numerical vehicle ID. |
datetime | The date and time desired. |
|
inline |
This function retrieves the profiles available for assignment to a vehicle, using SOAP.
Advanced Call, Max 60 Calls per Hour
Exceptions
token | A valid security token. |
vehicleid | The vehicle's numerical ID |
|
inline |
This function retrieves the profiles available for assignment to a vehicle, using REST.
Advanced Call, Max 60 Calls per Hour
Exceptions
token | A valid security token. |
vehicleid | The vehicle's numerical ID |
|
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
token | A valid security token. |
vehicleids | Comma seperated list of vehicle IDs |
datetime | Date/Time of the historical position (YYYY-MM-DD HH:MM:SS) |
|
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
token | A valid security token. |
vehicleids | Comma seperated list of vehicle IDs |
datetime | Date/Time of the historical position (YYYY-MM-DD HH:MM:SS) |
|
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
token | A valid security token. |
vehicleID | A numerical vehicle ID. |
|
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
token | A valid security token. |
vehicleID | A numerical vehicle ID. |
|
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
token | A valid security token. |
vehicleID | A numerical vehicle ID. |
|
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
token | A valid security token. |
vehicleID | A numerical vehicle ID. |
|
inline |
This function updates a vehicle's details using SOAP.
Bespoke Call, Max 60 Calls per Hour
Exceptions
token | A valid security token. |
vehicledetails | A VehicleDetails object. |
|
inline |
This function updates a vehicle's details using REST.
Bespoke Call, Max 60 Calls per Hour
Exceptions
token | A valid security token. |
vehicleid | The vehicleid for the details being saved/updated (readonly) |
vehicleregistration | The vehicle registration number, max length 20 |
fleetnumber | This is a free text field, used for grouping, max length 20 |
vehicledescription | This is a free text field, used for vehicle description, max length 50 |
vehiclemake | This is a free text field, used for vehicle make, max length 50 |
vehiclemodel | This is a free text field, used for vehicle Model, max length 50 |
vehiclecolour | This is a free text field, used for vehicle Colour, max length 50 |
vehiclevinnumber | This is a free text field, used for the Vehicle Identification (VIN) number, max length 50 |
enginenumber | This is a free text field, used for Vehicle Engine Number, max length 50 |
odometer | This is used to record the vehicle mileage. The value must be sent in meters. |
vehiclehours | This is used to record the vehicle running hours. The value may be overwritten and is specified in seconds. |
profileid | The profile ID to assign. |
serialnumber | The serial number of the unit (readonly) |
|
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
token | A valid security token. |
vehicleid | The numerical ID of the vehicle. |
lockstate | True/False boolean value to either lock or unlock (True = lock , False = unlock) |
|
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
token | A valid security token. |
vehicleid | The numerical vehicle ID. |
lockstate | True/False boolean value to either lock or unlock (True = lock , False = unlock) |