API Documentation

Manage Vehicles

The vehicles constitute a key part of the whole infrastructure. The autoaid devices will sort all captured information, such as the identifier, the model, or the manufacturer.

List Vehicles

Request
GET:
/vehicles
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.
Query Parameters (Optional)
modifyTimestamp:
UTC timestamp of last modification.
pageToken:
Page token to retrieve a specific page of results in the list.
maxResults:
Maximum number of results to return in one page.

var settings = {
    "async": true,
    "url": "https://api-production.autoaid.de/cc/v0.1/vehicles",
    "method": "GET",
    "headers": {
    "content-language": "en_US",
    "authorization": "Bearer API_KEY",
    "cache-control": "no-cache",
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
Response
nextPageToken:
Page token to retrieve a specific page of results in the list.
vehicleList:
List of vehicles.
Error Response
Code 401:
Unauthorized

{
  "nextPageToken": "2vb2s932",
  "vehicleList": [
    {
      "id": "VINYV1ZW25UDK1332944",
      "vin": "YV1ZW25UDK1332944",
      "tecDocMakeId": 120,
      "tecDocModelId": 38603,
      "tecDocVehicleId": 130835,
      "make": "VOLVO",
      "model": "V60 II (225)",
      "vehicle": "T5",
      "fuelType": "Petrol",
      "kba": null,
      "numberPlate": null,
      "deviceId": "861359023439131",
      "tripId": "90f228de5c611c7148d5",
      "timestamp": "2019-04-10 13:58:09.149606"
    }
  ]
}

Get Vehicle

Request
GET:
/vehicles/{vehicleId}
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.
Path Parameters (Required)
vehicleId:
Id of the vehicle.
Query Parameters (Optional)
modifyTimestamp:
UTC timestamp of last modification.
pageToken:
Page token to retrieve a specific page of results in the list.
maxResults:
Maximum number of results to return in one page.

var settings = {
  "async": true,
  "url": "https://api-production.autoaid.de/cc/v0.1/vehicles/VINYV1ZW25UDK1332944",
  "method": "GET",
  "headers": {
    "content-language": "en_US",
    "authorization": "Bearer API_KEY",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
Response
JSON object:
Requested vehicle.
Error Response
Code 401:
Unauthorized

{
    "id": "VINYV1ZW25UDK1332944",
    "vin": "YV1ZW25UDK1332944",
    "tecDocMakeId": 120,
    "tecDocModelId": 38603,
    "tecDocVehicleId": 130835,
    "make": "VOLVO",
    "model": "V60 II (225)",
    "vehicle": T5,
    "fuelType": Petrol,
    "kba": null,
    "numberPlate": null,
    "deviceId": "861359023439131",
    "tripId": "90f228de5c611c7148d5",
    "createTimestamp": "2019-04-10 13:58:09.149606",
    "modifyTimestamp": "2019-05-22 11:53:07.330029"
}

Manage Trips

A trip is a driven distance between two addresses. We include information about the origin and destination as well as some useful statistical data like distance and average speed.

List Trips

Request
GET:
/vehicles/{vehicleId}/trips
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.
Path Parameters (Required)
vehicleId:
Id of the vehicle.
Query Parameters (Optional)
modifyTimestamp:
UTC timestamp of last modification.
pageToken:
Page token to retrieve a specific page of results in the list.
maxResults:
Maximum number of results to return in one page.

var settings = {
  "async": true,
  "url": "https://api-production.autoaid.de/cc/v0.1/vehicles/VINYV1ZW25UDK1332944/trips",
  "method": "GET",
  "headers": {
    "content-language": "en_US",
    "authorization": "Bearer API_KEY",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
Response
nextPageToken:
Page token to retrieve a specific page of results in the list.
vehicleList:
List of vehicles.
Error Response
Code 401:
Unauthorized

{
    "nextPageToken": null,
    "prevPageToken": null,
    "modifyTimestamp": "2019-05-22 11:58:03.892131",
    "tripList": [
        {
            "id": "90f228de5c611c7148d5",
            "vehicleId": "VINYV1ZW25UDK1332944",
            "tripStartAddress": {
                "road": "Spanische Allee",
                "houseNumber": null,
                "suburb": "Nikolassee",
                "locality": "Berlin",
                "state": null,
                "country": "Deutschland",
                "postcode": "14129",
                "createTimestamp": "2019-05-22 11:23:05.860000",
                "modifyTimestamp": "2019-05-22 11:23:05.860000",
                "lat": 52.43413,
                "lon": 13.191543
            },
            "tripEndAddress": {
                "road": "Helmholtzstraße",
                "houseNumber": null,
                "suburb": "Charlottenburg",
                "locality": "Berlin",
                "state": "Berlin",
                "country": "Deutschland",
                "postcode": "10587",
                "createTimestamp": "2019-05-22 11:53:00.085000",
                "modifyTimestamp": "2019-05-22 11:53:00.085000",
                "lat": 52.52077,
                "lon": 13.323783
            },
            "averageSpeed": 35.12,
            "distance": 17503,
            "duration": 1794,
            "polyline": "oji_cBcqcdXk@aGTaKtCvIjHvMvMmHi@_~@aG}i@}k@{a@k}@i{@_wBcaCicDc`EorCwzDwaCsbDeoCuvDomEe_GycC}gDkgAowAsdDqqEwyBguCahA{|AefEc{FotJuuMsmBonCw_CiaDwhAytAu~@afAydEuaFabAwhAopC}cDqmEmxFahAq{Aux@ajAwgJsaM}xE}uGqgBygCypAgfBqyAusBezAuoB}i@ajASerAxWod@vQwMlPwEnX_Cx]wIdYmP`jA_~@fe@{e@fi@}m@fo@}i@|e@qh@dc@qh@xWeWjJaOlJyUwMcSeYcSadAorCea@owAcOifBaMmjCuCe_@wIw`AaI}q@kFy]_IabA{[{sCkFiw@uGio@ea@{wCkDwMaEgk@uEmTuAh@_CaGkBeg@uE_v@kBux@aK_uBkBgk@i@a~@`Qi{@bS_v@jH_z@`Esl@i@uE~B{a@Usp@kDytA?_v@uAq{AuGk_A_Cgs@aAik@i@e_@tAiD~@tAUmLuAqh@_IwhAuAk_AwEmkA_E}i@R_CSk@Uj@kHaGoV?od@tAeYkDuEkDyYuwBo\\vhAcQfg@cOkDuImPkHu`AwCyUStA?uAkFmPuC?RaCkJwMiw@_CmN_CyUwIyWcW_C?kDmPaGuA?uAaKvQaMd_@}o@f~AyQpl@wQ|e@uAaCkH`CmHb[wWtx@eYt`AoZrp@ytAbaC}g@rx@kH`Ge_@mPqd@aGy[dWo^k@qf@?qf@cSerAkcAo\\e[qf@eg@Th@wIlTwO~q@cSvhAaMhw@wQph@ySfc@e_@fo@uEuAoXec@y]{e@cSqh@aKsp@wKcnA?aKkB{YTmX~BwE`E`CjDwIvUjHjFrl@i@bSU?",
            "tripStartTimestamp": "2019-05-22 11:23:05.86",
            "tripEndTimestamp": "2019-05-22 11:53:00.085",
            "tripMileageStart": "2220",
            "tripMileageEnd": "2237",
            "accumulatedGpsDistanceEnd": "1208.93",
            "accumulatedGpsDistanceStart": "1191.962",
            "createTimestamp": "2019-05-22 11:23:13.229623",
            "modifyTimestamp": "2019-05-22 11:58:03.892131"
        }
    ]
}


Get Trip

Request
GET:
/vehicles/{vehicleId}/trips/{tripId}
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.
Path Parameters (Required)
vehicleId:
Id of the vehicle.
tripId:
Id of the trip.
Query Parameters (Optional)
modifyTimestamp:
UTC timestamp of last modification.
pageToken:
Page token to retrieve a specific page of results in the list.
maxResults:
Maximum number of results to return in one page.

var settings = {
  "async": true,
  "url": "https://api-production.autoaid.de/cc/v0.1/vehicles/VINYV1ZW25UDK1332944",
  "method": "GET",
  "headers": {
    "content-language": "en_US",
    "authorization": "Bearer API_KEY",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
Response
JSON object:
Requested trip.
Error Response
Code 401:
Unauthorized

{
    "id": "90f228de5c611c7148d5",
    "vehicleId": "VINYV1ZW25UDK1332944",
    "tripStartAddress": {
        "road": "Spanische Allee",
        "houseNumber": null,
        "suburb": "Nikolassee",
        "locality": "Berlin",
        "state": null,
        "country": "Deutschland",
        "postcode": "14129",
        "createTimestamp": "2019-05-22 11:23:05.860000",
        "modifyTimestamp": "2019-05-22 11:23:05.860000",
        "lat": 52.43413,
        "lon": 13.191543
    },
    "tripEndAddress": {
        "road": "Helmholtzstraße",
        "houseNumber": null,
        "suburb": "Charlottenburg",
        "locality": "Berlin",
        "state": "Berlin",
        "country": "Deutschland",
        "postcode": "10587",
        "createTimestamp": "2019-05-22 11:53:00.085000",
        "modifyTimestamp": "2019-05-22 11:53:00.085000",
        "lat": 52.52077,
        "lon": 13.323783
    },
    "averageSpeed": 35.12,
    "distance": 17503,
    "duration": 1794,
    "polyline": "oji_cBcqcdXk@aGTaKtCvIjHvMvMmHi@_~@aG}i@}k@{a@k}@i{@_wBcaCicDc`EorCwzDwaCsbDeoCuvDomEe_GycC}gDkgAowAsdDqqEwyBguCahA{|AefEc{FotJuuMsmBonCw_CiaDwhAytAu~@afAydEuaFabAwhAopC}cDqmEmxFahAq{Aux@ajAwgJsaM}xE}uGqgBygCypAgfBqyAusBezAuoB}i@ajASerAxWod@vQwMlPwEnX_Cx]wIdYmP`jA_~@fe@{e@fi@}m@fo@}i@|e@qh@dc@qh@xWeWjJaOlJyUwMcSeYcSadAorCea@owAcOifBaMmjCuCe_@wIw`AaI}q@kFy]_IabA{[{sCkFiw@uGio@ea@{wCkDwMaEgk@uEmTuAh@_CaGkBeg@uE_v@kBux@aK_uBkBgk@i@a~@`Qi{@bS_v@jH_z@`Esl@i@uE~B{a@Usp@kDytA?_v@uAq{AuGk_A_Cgs@aAik@i@e_@tAiD~@tAUmLuAqh@_IwhAuAk_AwEmkA_E}i@R_CSk@Uj@kHaGoV?od@tAeYkDuEkDyYuwBo\\vhAcQfg@cOkDuImPkHu`AwCyUStA?uAkFmPuC?RaCkJwMiw@_CmN_CyUwIyWcW_C?kDmPaGuA?uAaKvQaMd_@}o@f~AyQpl@wQ|e@uAaCkH`CmHb[wWtx@eYt`AoZrp@ytAbaC}g@rx@kH`Ge_@mPqd@aGy[dWo^k@qf@?qf@cSerAkcAo\\e[qf@eg@Th@wIlTwO~q@cSvhAaMhw@wQph@ySfc@e_@fo@uEuAoXec@y]{e@cSqh@aKsp@wKcnA?aKkB{YTmX~BwE`E`CjDwIvUjHjFrl@i@bSU?",
    "tripStartTimestamp": "2019-05-22 11:23:05.86",
    "tripEndTimestamp": "2019-05-22 11:53:00.085",
    "tripMileageStart": "2220",
    "tripMileageEnd": "2237",
    "accumulatedGpsDistanceEnd": "1208.93",
    "accumulatedGpsDistanceStart": "1191.962",
    "createTimestamp": "2019-05-22 11:23:13.229623",
    "modifyTimestamp": "2019-05-22 11:58:03.892131"
}

Manage Vehicle Status

The status gives you access to vehicle data regarding only the current point in time. This includes the car and driver information, technical specifications, and data about the device itself. The status is accessible with a single service call to retrieve information for one vehicle or your entire fleet. In case the resulting information turns out to be too long, it can be paginated.

List Status Vehicles

Request
GET:
/status/vehicles
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.
Query Parameters (Optional)
modifyTimestamp:
UTC timestamp of last modification.
pageToken:
Page token to retrieve a specific page of results in the list.
maxResults:
Maximum number of results to return in one page.

var settings = {
    "async": true,
    "url": "https://api-production.autoaid.de/cc/v0.1/status/vehicles",
    "method": "GET",
    "headers": {
    "content-language": "en_US",
    "authorization": "Bearer API_KEY",
    "cache-control": "no-cache",
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
Response
nextPageToken:
Page token to retrieve a specific page of results in the list.
vehicleList:
List of vehicles.
Error Response
Code 401:
Unauthorized

{
  "nextPageToken": null,
  "prevPageToken": null,
  "modifyTimestamp": "2019-05-26 15:51:54.675259",
  "statusList": [
    {
      "deviceStatus": {
        "id": "861359033438738",
        "hardwareType": "autoaid Telematic",
        "hardwareVersion": "C4",
        "firmwareVersion": null,
        "deviceGroupId": null,
        "createTimestamp": "2019-05-22 09:18:45.960572",
        "modifyTimestamp": "2019-05-26 15:10:48.671442",
        "vendor": "autoaid",
        "isConnected": null,
        "vehicleId": "VINWVGZZZ1TZDW060711",
        "tripId": "4c00fbe851a6c70d3e94",
        "connected": null
      },
      "vehicleStatus": {
        "id": "VINWVGZZZ1TZDW060711",
        "vin": "WVGZZZ1TZDW060711",
        "tecDocMakeId": 121,
        "tecDocModelId": 10449,
        "tecDocVehicleId": null,
        "make": "VW",
        "model": "TOURAN (1T3)",
        "vehicle": null,
        "fuelType": null,
        "kba": null,
        "numberPlate": null,
        "deviceId": "861359033438738",
        "tripId": "4c00fbe851a6c70d3e94",
        "createTimestamp": "2019-05-24 06:35:59.61524",
        "modifyTimestamp": "2019-05-26 15:10:48.659837"
      },
      "eventStatusList": [{
          "eventType": "BATTERY_VOLTAGE",
          "eventDataType": "PARAMETER",
          "eventData": {
            "createTimestamp": "2019-05-24 06:35:59.603921",
            "modifyTimestamp": "2019-05-26 15:10:40.145000",
            "value": "12.3",
            "unitId": 40,
            "unitType": "V"
          }
        },
        {
          "eventType": "STANDBY_STATE",
          "eventDataType": "PARAMETER",
          "eventData": {
            "createTimestamp": "2019-05-24 06:35:59.606805",
            "modifyTimestamp": "2019-05-26 15:10:35.541000",
            "value": "standby_on",
            "unitId": 10,
            "unitType": ""
          }
        }
      ]
    }
  ]
}

Get Status Vehicle

Request:
GET:
/status/vehicles/{vehicleId}
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.
Path Parameters (Required)
vehicleId:
Id of the vehicle.
Query Parameters (Optional)
modifyTimestamp:
UTC timestamp of last modification.

var settings = {
    "async": true,
    "url": "https://api-production.autoaid.de/cc/v0.1/status/vehicles/VINYV1ZW25UDK1332944",
    "method": "GET",
    "headers": {
    "content-language": "de_DE",
    "authorization": "Bearer API_KEY"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
Response
JSON object:
Status of vehicle.
Error Response
Code 401:
Unauthorized

{
"deviceStatus": {
    "id": "861359033439520",
    "hardwareType": "autoaid Telematic",
    "hardwareVersion": "C4",
    "firmwareVersion": "1.0 M1",
    "deviceGroupId": null,
    "createTimestamp": "2019-04-03 09:27:24.810002",
    "modifyTimestamp": "2019-05-22 11:53:07.334445",
    "vendor": "autoaid",
    "isConnected": true,
    "vehicleId": "VINYV1ZW25UDK1332944",
    "tripId": "90f228de5c611c7148d5",
},
"vehicleStatus": {
    "id": "VINYV1ZW25UDK1332944",
    "vin": "YV1ZW25UDK1332944",
    "tecDocMakeId": 120,
    "tecDocModelId": 38603,
    "tecDocVehicleId": null,
    "make": "VOLVO",
    "model": "V60 II (225)",
    "vehicle": null,
    "fuelType": null,
    "kba": null,
    "numberPlate": null,
    "deviceId": "861359033439520",
    "tripId": "90f228de5c611c7148d5",
    "createTimestamp": "2019-04-10 13:58:09.149606",
    "modifyTimestamp": "2019-05-22 11:53:07.330029"
},
"eventStatusList": [{
    "eventType": "POSITION",
    "eventDataType": "GEO",
    "eventData": {
        "createTimestamp": "2019-04-10 13:58:23.100201",
        "modifyTimestamp": "2019-05-22 11:50:57.000000",
        "lon": "13.323766",
        "lat": "52.520815"
    }
    },{
    "eventType": "MILEAGE",
    "eventDataType": "PARAMETER",
    "eventData": {
        "createTimestamp": "2019-04-18 06:32:57.854499",
        "modifyTimestamp": "2019-05-22 11:50:20.276000",
        "value": "2237",
        "unitId": 111,
        "unitType": "km"
    }
    },{
    "eventType": "FUEL_LEVEL",
    "eventDataType": "PARAMETER",
    "eventData": {
        "createTimestamp": "2019-04-24 08:10:28.266681",
        "modifyTimestamp": "2019-05-22 11:50:20.276000",
        "value": "8.3",
        "unitId": 90,
        "unitType": "l"
    }
}]}

Manage Events

Events are designed to be very versatile and comprehensive. Basically, any available data set can be defined as an event. This includes live data as well as the data history. Events allow for a wide range of implementations, e.g. regarding refueling stops or track & trace functionality.

List Events

Request
GET:
/vehicles/{vehicleId}/events
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.
Path Parameters (Required)
vehicleId:
Id of the vehicle.
Query Parameters (Optional)
eventType:
Filter events by event type.
tripId:
Filter events by id of a trip.
toTime:
Filter events by time.
fromTime:
Filter events by time.
modifyTimestamp:
UTC timestamp of last modification.
pageToken:
Page token to retrieve a specific page of results in the list.
maxResults:
Maximum number of results to return in one page.

var settings = {
    "async": true,
    "url": "https://api-production.autoaid.de/cc/v0.1/vehicles/VINYV1ZW25UDK1332944/events?maxResults=2",
    "method": "GET",
    "headers": {
    "content-language": "de_DE",
    "authorization": "Bearer API_KEY",
    }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
Response
nextPageToken:
Page token to retrieve a specific page of results in the list.
vehicleList:
List of vehicles.
Error Response
Code 401:
Unauthorized

{
  "nextPageToken": "MiwyLG51bGw=",
  "modifyTimestamp": "2019-05-22 11:53:00.085",
  "eventList": [{
      "tripId": "90f228de5c611c7148d5",
      "vehicleId": "VINYV1ZW25UDK1332944",
      "deviceId": "861359033439520",
      "eventType": "ACCUMULATED_GPS_DISTANCE",
      "eventDataType": "PARAMETER",
      "eventData": {
        "createTimestamp": "2019-05-22 11:53:00.085000",
        "modifyTimestamp": "2019-05-22 11:53:07.312784",
        "value": "1208.93",
        "unitId": 10,
        "unitType": ""
      }
    },{
      "tripId": "90f228de5c611c7148d5",
      "vehicleId": "VINYV1ZW25UDK1332944",
      "deviceId": "861359033439520",
      "eventType": "CURRENT_TRIP_GPS_DISTANCE",
      "eventDataType": "PARAMETER",
      "eventData": {
        "createTimestamp": "2019-05-22 11:53:00.085000",
        "modifyTimestamp": "2019-05-22 11:53:07.321484",
        "value": "16.968000000000075",
        "unitId": 111,
        "unitType": "km"
      }
    }
  ]
}

Manage Types

List Unit Types

Request
GET:
/unitTypes
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.

var settings = {
    "async": true,
    "url": "https://api-production.autoaid.de/cc/v0.1/unitTypes",
    "method": "GET",
    "headers": {
    "content-language": "en_US",
    "authorization": "Bearer API_KEY"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
Response
JSON array:
List of unit types.
Error Response
Code 401:
Unauthorized

[{
    "id": 20,
    "unitType": "%"
}, {
    "id": 90,
    "unitType": "l"
},{
    "id": 111,
    "unitType": "km"
},{
    "id": 40,
    "unitType": "V"
}, ... ]

List Event Types

Request
GET:
/eventTypes
Header (Required)
Authorization:
API Key.
Content-Language:
Desired language code.

var settings = {
    "async": true,
    "url": "https://api-production.autoaid.de/cc/v0.1/eventTypes",
    "method": "GET",
    "headers": {
    "content-language": "de_DE",
    "authorization": "Bearer API_KEY"
    }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
Response
JSON array:
List of possible event types.
Error Response
Code 401:
Unauthorized

[{
    "eventType": "MIL",
    "eventDataType": "PARAMETER"
},{
    "eventType": "BATTERY_VOLTAGE",
    "eventDataType": "PARAMETER"
},{
    "eventType": "FIRMWARE",
    "eventDataType": "PARAMETER"
},{
    "eventType": "FUEL_LEVEL",
    "eventDataType": "PARAMETER"
},{
    "eventType": "POSITION",
    "eventDataType": "GEO"
},{
    "eventType": "MILEAGE",
    "eventDataType": "PARAMETER"
},  ... ]