developer portal

Fleet

Get Speedings

Returns a list of all speedings by users or vehicles within a date/time range. Provide either some user id's or vehicle id's to identify resources.

Request body

object

FieldTypeRequired
Fromstringrequired
Tostringrequired
UserIds(default = [])arrayoptional
VehicleIds(default = [])arrayoptional

Responses

200OK
[
  {
    "DateTime": "2019-03-12T11:00:51+01:00",
    "VehicleId": "00000000-0000-0000-0000-000000000000",
    "VehicleName": "Vehicle 1",
    "VehicleLicensePlate": "1-ABC-123",
    "DriverId": "00000000-0000-0000-0000-000000000000",
    "DriverName": "John Doe",
    "Speed": 121,
    "MaxSpeed": 100,
    "Fine": 65,
    "Revocation": false,
    "TooltipEn": null,
    "TooltipFr": null,
    "TooltipNl": null
  }
]
401Unauthorized
403Forbidden

Create driver identification

Creates a new driver identification.

Request body

object

FieldTypeRequired
UserCodestringrequired
VehicleCodestringrequired
StartDateTimestringrequired

Responses

200OK
400BadRequest
FieldType
UserCodestring
VehicleCodestring
StartDateTimestring
{
  "UserCode": "012345",
  "VehicleCode": "012345",
  "StartDateTime": "2019-03-12T11:00:51+01:00"
}
401Unauthorized
403Forbidden
417ExpectationFailed
500InternalServerError

Import fuel transactions

Imports one or more fuel transactions.

Request body

object

FieldTypeRequired
FuelTransactions(default = [])arrayoptional

Responses

200OK
400BadRequest
[
  {
    "Entity": {
      "TrackingDeviceId": "1000000000",
      "TransactionNumber": "1",
      "Timestamp": "2019-01-23T04:56:07",
      "Liters": 65.5,
      "Price": 70.4,
      "Source": "1000",
      "Mileage": 1245.4
    },
    "ValidationResult": [
      {
        "Message": "",
        "SourceMemberNames": []
      }
    ]
  }
]
401Unauthorized
403Forbidden
417ExpectationFailed

Get fuel transactions

Returns a list of fuel transactions, optionally filtered by users, vehicles, fuel pumps and/or fuel tanks.

Query parameters

NameTypeRequiredExample
fromDatestringrequired2019-01-17T00:00:00
toDatestringrequired2019-01-18T23:59:59

Request body

object

FieldTypeRequired
Users(default = [])arrayoptional
Resources(default = [])arrayoptional
Tanks(default = [])arrayoptional
Pumps(default = [])arrayoptional
UnlinkedTransactions(default = false)booleanoptional

Responses

200OK
[
  {
    "DateTime": "2019-01-25T08:29:37",
    "FuelTank": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Tank",
      "Capacity": 1500,
      "Limit": 1500,
      "CurrentLevel": 1500,
      "FuelType": 1,
      "FuelTypeName": "Diesel"
    },
    "FuelPump": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Pump",
      "Code": "1500",
      "FuelType": 1,
      "FuelTypeName": "Diesel",
      "Type": 1,
      "TypeName": "VehicleCode_Info"
    },
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "John Doe",
      "Code": "012345"
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Vehicle 1",
      "Code": "012345",
      "LicensePlate": "1-ABC-123"
    },
    "TransactionNumber": "00000000",
    "Price": 10,
    "Liters": 10,
    "KmVehicle": 10,
    "KmUser": 10,
    "KmDriven": 0,
    "AvgConsumption": 0,
    "Type": "Bijtanken",
    "Info": "",
    "VehicleIdentification": "500145"
  }
]
401Unauthorized
403Forbidden

Get vehicle usage

Returns a list of vehicle usages by person.

Query parameters

NameTypeRequiredExample
fromDatestringrequired2019-01-17T00:00:00+01:00
toDatestringrequired2019-01-18T23:59:59+01:00
includeClockingsbooleanoptionalfalse
includeStopsbooleanoptionalfalse
includeDrivingsbooleanoptionalfalse

Request body

Responses

200OK
[
  {
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "John Doe",
      "Code": "012345",
      "EmployerCode": "012345",
      "Email": "john.doe@doe.com",
      "Gsm": "+32477665544",
      "FreeField1": null,
      "FreeField2": null,
      "FreeField3": null,
      "FreeField4": null,
      "FreeField5": null,
      "FreeField6": null,
      "Notes": null,
      "Street": "Dumolinlaan",
      "HouseNumber": "9",
      "City": "Kortrijk",
      "PostalCode": "8500",
      "Submunicipality": "Kortrijk",
      "Country": 0,
      "Longitude": 3.245304,
      "Latitude": 50.812939,
      "DefaultDayProgram": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Default"
      },
      "Groups": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Employees",
          "Type": 0,
          "Code": "012345"
        }
      ]
    },
    "Days": [
      {
        "Date": "2019-01-17T00:00:00",
        "VehicleUsages": [
          {
            "Vehicle": {
              "Id": "00000000-0000-0000-0000-000000000000",
              "Name": "Vehicle 1",
              "IvrCode": null,
              "Code": "012345",
              "Category": 0,
              "FuelType": "1",
              "Co2Emission": 80,
              "RowOfSeatsCount": 2,
              "SeatsCount": 5,
              "LicensePlate": "1-ABC-123",
              "VinNumber": "ABCDE01234F567890",
              "HasTrackingData": false,
              "LastReportDate": "2019-03-19T11:45:47+01:00",
              "LastSyncDate": "2019-03-19T11:45:47+01:00",
              "UserNotes": null,
              "Weight": 600,
              "EmissionStandard": "300",
              "MaximumSpeed": 220,
              "NominalConsumption": 5.5,
              "CostCenter": {
                "Id": "00000000-0000-0000-0000-000000000000",
                "Name": "Workplace 1",
                "Code": "012345",
                "Poi": {
                  "Id": "00000000-0000-0000-0000-000000000000",
                  "Name": "Work",
                  "Code": "012345",
                  "PoiType": {
                    "Id": "00000000-0000-0000-0000-000000000000",
                    "Name": "Work place",
                    "Color": "#00FF2F"
                  },
                  "IsAssetLocation": false,
                  "Street": "Dumolinlaan",
                  "HouseNumber": "9",
                  "City": "Kortrijk",
                  "Submunicipality": "Kortrijk",
                  "PostalCode": "8500",
                  "Country": 0,
                  "Priority": "0",
                  "Description": "Work",
                  "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
                  "LonMin": 3.145219,
                  "LonMax": 3.244998,
                  "LatMin": 50.81309,
                  "LatMax": 50.91806,
                  "MarkerLon": 3.145219,
                  "MarkerLat": 50.81309,
                  "IsLambert72": false,
                  "Radius": 0.03,
                  "ReverseGeocoding": false,
                  "Groups": [
                    {
                      "Id": "00000000-0000-0000-0000-000000000000",
                      "Name": "Work places",
                      "Pois": [
                        {}
                      ],
                      "NumberOfPois": 1
                    }
                  ]
                }
              },
              "Groups": [
                {
                  "Id": "00000000-0000-0000-0000-000000000000",
                  "Name": "Employees",
                  "Type": 0,
                  "Code": "012345"
                }
              ]
            },
            "MileageTotal": 236.5,
            "TotalPowerLost": 0,
            "Mileage": 5650.406,
            "Clockings": [
              {
                "User": {
                  "Id": "00000000-0000-0000-0000-000000000000",
                  "Name": "John Doe",
                  "Code": "012345",
                  "EmployerCode": "012345",
                  "Email": "john.doe@doe.com",
                  "Gsm": "+32477665544",
                  "FreeField1": null,
                  "FreeField2": null,
                  "FreeField3": null,
                  "FreeField4": null,
                  "FreeField5": null,
                  "FreeField6": null,
                  "Notes": null,
                  "Street": "Dumolinlaan",
                  "HouseNumber": "9",
                  "City": "Kortrijk",
                  "PostalCode": "8500",
                  "Submunicipality": "Kortrijk",
                  "Country": 0,
                  "Longitude": 3.245304,
                  "Latitude": 50.812939,
                  "DefaultDayProgram": {
                    "Id": "00000000-0000-0000-0000-000000000000",
                    "Name": "Default"
                  },
                  "Groups": [
                    {
                      "Id": "00000000-0000-0000-0000-000000000000",
                      "Name": "Employees",
                      "Type": 0,
                      "Code": "012345"
                    }
                  ]
                },
                "DateTime": "2019-01-17T06:02:03+01:00"
              }
            ],
            "Stops": [
              {
                "Location": "Dumolinlaan 9, 8500 Kortrijk [Kortrijk], BE",
                "Pois": [
                  {
                    "Id": "00000000-0000-0000-0000-000000000000",
                    "Name": "Work"
                  }
                ],
                "From": "2019-01-17T06:57:53+01:00",
                "To": "2019-01-17T08:41:43+01:00"
              }
            ],
            "Drivings": [
              {
                "From": "2019-01-17T06:57:53+01:00",
                "To": "2019-01-17T08:41:43+01:00"
              }
            ]
          }
  
...
(truncated)
401Unauthorized
403Forbidden

Update vehicle and create driver identification

Updates a vehicle by tracking device unit id and creates a new driver identification by user code.

If necessary, a new user and/or user group is created before creating a driver identification.

Request body

object

FieldTypeRequired
TrackingDeviceIdThe unique vehicle unit id.stringrequired
VehicleNamestringrequired
Licenseplate(default = null)stringoptional
Vin(default = null)stringoptional
FuelTypestringrequired
FuelConsumption(default = 0.0)numberoptional
UserNamestringrequired
UserCodeThe user and user group code seperated by `/`.stringrequired
DriverStartstringrequired

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "TrackingDeviceId": "1000000000",
    "VehicleName": "Vehicle 1",
    "Licenseplate": "1-ABC-123",
    "Vin": "ABCDE01234F567890",
    "FuelType": "d",
    "FuelConsumption": 5.5,
    "UserName": "John Doe",
    "UserCode": "012345/9876",
    "DriverStart": "2019-01-24T17:00:00"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
500InternalServerError

Get transport tickets by date

Returns a list of all the tickets from the given date.

Path parameters

NameTypeRequiredExample
datestringrequired2020-01-01

Responses

200OK
FieldType
Data(default = null)array
ValidationResultarray
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "TransportTicketUser": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "John Doe",
        "UserTypes": [
          0
        ],
        "VehicleType": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Vehicle Type"
        },
        "InternalCode": "0123456789",
        "Email": "johndoe@company.com",
        "PhoneNumber": "+32123456789"
      },
      "TransportTicketCompany": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "John Doe",
        "Vat": "0123456789",
        "Email": "johndoe@company.com"
      },
      "Date": "2021-07-12T08:29:37",
      "Pause": {
        "Enabled": true,
        "Value": "01:00:00",
        "Remark": "remark"
      },
      "Return": {
        "Enabled": true,
        "Value": "01:00:00",
        "Remark": "remark"
      },
      "Total": "01:00:00",
      "TransporterInfo": {
        "AlreadyLoaded": true,
        "Mileage": 107
      },
      "CreationTime": "2021-07-12T08:29:37",
      "Registrations": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Type": 0,
          "Remark": "remark",
          "Arrival": "2021-07-12T08:29:37",
          "Departure": "2021-07-12T08:29:37",
          "SubmitTimeStamp": "2021-07-12T08:29:37",
          "Poi": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "Work",
            "Code": "012345"
          },
          "WorkplaceNumber": "12345",
          "StartReference": {},
          "TransporterInfo": {
            "MachineNumber": "12345",
            "Counter": 107
          },
          "Address": {
            "CountryName": "Belgium",
            "AddressLine": "Dumolinlaan 9, 8500 Kortrijk, BE",
            "PoiList": [
              "00000000-0000-0000-0000-000000000000",
              "00000000-0000-0000-0000-000000000000"
            ],
            "City": "Kortrijk",
            "CityLine": "8500 Kortrijk, BE",
            "CountryCode": 0,
            "HouseNumber": "9",
            "Latitude": 50.812939,
            "Longitude": 3.245304,
            "PostalCode": "8500",
            "ShortAddressLine": "Dumolinlaan 9, Kortrijk, BE",
            "Street": "Dumolinlaan",
            "StreetLine": "Dumolinlaan 9",
            "Submunicipality": "Kortrijk"
          }
        }
      ],
      "TransportTicketUserType": 0
    }
  ],
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden