PreApi Logbookie (1.0.0)

Download OpenAPI specification:

Introduction

Basic information

API endpoint: https://preapi.logbookie.eu/api/v1
Staging endpoint: https://testapi.logbookie.eu/api/v1 used for testing new features.
On errors, the API returns an appropriate HTTP status code in the response header.
If an error occurs in the HTTP parameters, a JSON object with error details is returned.
The API uses UTF-8 encoding, and all incoming requests must use this encoding as well.
GPS data upload frequency depends on device configuration (between 10 seconds and 2 minutes).
Timestamps timezone is UTC. (The system does not depend on any specific time zone for its operations.)

Required headers

Every request must include at least one of the following headers, and any of them may be present together:
- Content-Type: application/json
- Accept: application/json

Authentication

Authentication takes place using a token issued for a specific user.
This token must be included in the Dho-Access-Token request http header.

Limits

Maximum frequency for pulling the data is 80 requests per minute.
Maximum frequency for pulling the data is 600 requests per hour.
We don’t have requirements for IP whitelisting at this moment.

Status codes

200 OK - Successful request. In most cases. the JSON is returned.
400 Bad Request - The request contains an error or the JSON object structure is not valid.
401 Unauthorized - Missing authentication header, invalid login, or invalid token.
403 Forbidden - There are not enough rights to execute the request.
404 Not Found - Url does not exist.
500 Internal Server Error - Unexpected server error, please contact technical support at support@logbookie.eu.

List requests

All requests under this tag share the same basic output structure.

Response Structure:

{
    "meta": {
        "totalRows": 2524
    },
    "rowData": [{}]
}

meta.totalRows: The total number of rows in the response.
rowData: An array of objects, with the structure depending on the specific request.

More information about JSON query objects can be found here: https://restdb.io/docs/querying-with-the-api#logicXoperators

lastPosition

Provide the latest vehicle locations and positions.

Authorizations:

Dho-Access-Token

query Parameters

q	string Filter results by a search query.
limit	integer <= 1000 Default: 25 Number of items per page (default: 25, max: 1000).
page	integer Default: 1 The page number to retrieve (default: 1).
	object Example: time=desc&name=asc Sort results by a specific field.

Responses

Response samples

200

Content type

application/json

{"meta": {"totalRows": 0
},
"rowData": [{"id": "s~375d370cef00bb32eb6e2a0b731b6ce9c07d9ad9f5",
"rideType": 0,
"time": 1732700103,
"location": "Masarykovo nám. 280/12a, 697 01 Kyjov, CZ",
"lat": 49.00949,
"lon": 17.123777,
"odometer": null,
"motohours": null,
"velocity": 0.5,
"movementStatus": "end",
"driverId": {"id": "s~4e1547707e658f9644bae56eb395503b97"
},
"vehicleId": {"id": "s~d47f60ac959372edee1a0b536ba0300cef57704680"
},
"locationType": "valid",
"direction": 0.5
}
]
}

vehicle

Provide a list of the user's vehicles

Authorizations:

Dho-Access-Token

query Parameters

q	string Filter results by a search query.
limit	integer <= 1000 Default: 25 Number of items per page (default: 25, max: 1000).
page	integer Default: 1 The page number to retrieve (default: 1).
	object Example: time=desc&name=asc Sort results by a specific field.

Responses

Response samples

200

Content type

application/json

{"meta": {"totalRows": 0
},
"rowData": [{"id": "s~462defb59ffb923dfbe4a3b130bf09e8646bd29b9d",
"title": "Škoda Octavia",
"licensePlate": "6AL 4788",
"odometer": 197567000,
"motohours": null,
"timeDeviceAdded": 1509518838,
"monitorMotohours": false,
"fuelCellVolume": 0.055,
"fuelType": "benzine",
"vehicleType": "car",
"defaultDriverId": {"id": "s~2f772b768f7344c1e7adb436ba195501ca0f4939cf"
},
"divisionId": {"id": "s~8d66c56e62c9afbd0128485e4a4b637b74f3019a83"
},
"currency": "CZK"
}
]
}

ride

Provide the trip history for the vehicle.

Authorizations:

Dho-Access-Token

query Parameters

q	string Filter results by a search query.
limit	integer <= 1000 Default: 25 Number of items per page (default: 25, max: 1000).
page	integer Default: 1 The page number to retrieve (default: 1).
	object Example: time=desc&name=asc Sort results by a specific field.

Responses

Response samples

200

Content type

application/json

{"meta": {"totalRows": 0
},
"rowData": [{"id": "s~0cd8be45584d5877fa1ad0498e46b587e2a5b332b82c7ff9",
"timeFrom": 1630646933,
"timeTo": 1630647466,
"speedAvg": 1.1472222222222221,
"consumption": 0,
"countryCode": "CZ",
"locationFrom": null,
"lonFrom": 16.626643,
"latFrom": 49.202845,
"locationTo": null,
"lonTo": 16.62662,
"latTo": 49.202849,
"rideType": 0,
"distance": 28.622999999999998,
"price": 0,
"vehicleId": {"id": "s~37ed89c15fbafce459e462247112ff93e6a5bc35be"
},
"driverId": {"id": "s~4e156eb395503b9747707e658f9644bae5"
},
"bookType": "main",
"dataType": "gps"
}
]
}

division

Provide user's division list.

Authorizations:

Dho-Access-Token

query Parameters

q	string Filter results by a search query.
limit	integer <= 1000 Default: 25 Number of items per page (default: 25, max: 1000).
page	integer Default: 1 The page number to retrieve (default: 1).
	object Example: time=desc&name=asc Sort results by a specific field.

Responses

Response samples

200

Content type

application/json

{"meta": {"totalRows": 0
},
"rowData": [{"id": "s~700963662dff8be4a2b730bbb4afaff54e12e0a598",
"name": "Test division",
"countryCode": "CZ",
"active": true
}
]
}

refuel

Provide refueling details, including fuel transactions and related information.

Authorizations:

Dho-Access-Token

query Parameters

q	string Filter results by a search query.
limit	integer <= 1000 Default: 25 Number of items per page (default: 25, max: 1000).
page	integer Default: 1 The page number to retrieve (default: 1).
	object Example: time=desc&name=asc Sort results by a specific field.

Responses

Response samples

200

Content type

application/json

{"meta": {"totalRows": 0
},
"rowData": [{"id": "s~f2a9a42c2d6f52a1663f03c008f3db28e3a2b734bf2c",
"time": 1638353414,
"origin": "Eurowag",
"productName": "Motorová nafta",
"productType": "benzine",
"description": null,
"stationName": "BENZINA - Mladá Boleslav II",
"gasCellFull": true,
"dateModified": 1642163347,
"dateAdded": 1642163323,
"amount": 0.04134,
"price": {"amount": 1477.63,
"currency": "CZK",
"vat": 21
},
"vehicleId": {"id": "s~37ed89c15fbafce459e462247112ff93e6a5bc35be"
},
"userId": {"id": "s~790eedaffb9109f55fadc014ed3e56c6e7a2b630b7"
}
}
]
}

user

Provide user details and related information.

Authorizations:

Dho-Access-Token

query Parameters

q	string Filter results by a search query.
limit	integer <= 1000 Default: 25 Number of items per page (default: 25, max: 1000).
page	integer Default: 1 The page number to retrieve (default: 1).
	object Example: time=desc&name=asc Sort results by a specific field.

Responses

Response samples

200

Content type

application/json

{"meta": {"totalRows": 0
},
"rowData": [{"id": "s~790eedaffb9106e7a2b630b79f55fadc014ed3e56c",
"name": "Podpora",
"surname": null,
"login": "podpora@logbookie.eu",
"email": "podpora@logbookie.eu",
"customerId": {"id": "s~94a42a8b628cd6c36a112e6a2b03cbf6e08bed16d5"
},
"timezone": "Europe/Prague",
"active": true,
"disabled": false
}
]
}

odometer

Provides user-defined odometer correction data.

Authorizations:

Dho-Access-Token

query Parameters

q	string Filter results by a search query.
limit	integer <= 1000 Default: 25 Number of items per page (default: 25, max: 1000).
page	integer Default: 1 The page number to retrieve (default: 1).
	object Example: time=desc&name=asc Sort results by a specific field.

Responses

Response samples

200

Content type

application/json

{"meta": {"totalRows": 0
},
"rowData": [{"id": "s~3128ff13b93f364e4a08736b7c09dd80402d2bcac425",
"active": true,
"time": 1630646799,
"perc": 0,
"odometer": 2891000,
"vehicleId": {"id": "s~37ed89c459e93e6a5bc315fbafce5462247112ffbe"
},
"userId": {"id": "s~790eedaffb9d3e59f51dc006c6e7a2b14e5fa630b7"
}
}
]
}

Common requests

currentUser

Provide details of the currently logged-in user.

Authorizations:

Dho-Access-Token

Responses

Response samples

200

Content type

application/json

{"userData": {"id": 12345,
"login": "Prokop Dveře",
"lastName": "Dveře",
"firstName": "Prokop",
"loginHash": "f5cf5c944cd9ab10d8a8721bf95b1d99",
"role": "user",
"timezone": "Europe/Prague"
}
}

vehicleDailyIncrement

Provide a daily summary of the distance traveled (in meters) or the increase in engine runtime (in seconds) for each vehicle.

Authorizations:

Dho-Access-Token

query Parameters

vehicleIds required	string Ids of vehicles
timeFrom required	number <float> Timestamp of interval first day start
timeTo required	number <float> Timestamp of interval last day

Responses

Response samples

200

Content type

application/json

{"vehicle": "s~5b61023db5887e9gh986f16058f1249ce6a5bc11b8",
"dailyIncrements": [{"date": "1680386400",
"odometerIncrement": 625.01,
"motohoursIncrement": 6000.12
},
{"date": "1680559200",
"odometerIncrement": 625.01,
"motohoursIncrement": 7850.12
},
{"date": "1680645600",
"odometerIncrement": 625.01,
"motohoursIncrement": 985.12
}
]
}

vehicleMovement

Provide GPS coordinates, speed information, and the route taken by the vehicle.

Authorizations:

Dho-Access-Token

query Parameters

vehicleIds required	string Ids of vehicles
timeFrom required	number <float> Timestamp of interval first day start
timeTo required	number <float> Timestamp of interval last day

Responses

Response samples

200

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"properties": {"vehicleId": "s~5c7d7c687adf79a21a15c02de7a4b48d52846130",
"coordTimes": [1705391253,
1705391263,
1705391266,
1705391267,
1705391268,
1705391269,
1705391271,
1705391274,
1705391277,
1705391279
],
"speed": [0,
0,
1.9444444444,
1.9444444444444444,
1.9444444444444444,
2.2222222222222223,
2.7777777777777777,
5.277777777777778,
7.777777777777778,
10,
10.555555555555555
]
},
"geometry": {"type": "LineString",
"coordinates": [[16.564008,
49.169038
],
[16.564008,
49.169038
],
[16.563968,
49.169033
],
[16.563997,
49.169038
],
[16.564017,
49.16905
],
[16.564025,
49.169072
],
[16.564002,
49.169143
],
[16.563922,
49.169317
],
[16.563838,
49.169565
],
[16.563807,
49.169753
]
]
}
}
]
}