KEYSTONE API Standard
  1. Vehicle
KEYSTONE API Standard
  • KEYSTONE API Standard
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
  • Paths & Endpoints
    • Transport Operation
      • Create new transport operation data
      • Get all transport operation data
      • Get a specific transport operation data by ID
      • Update data for a specific transport operation by ID
      • Delete specific transport operation data by ID
      • Get schedule data related to a specific transport operation by ID
      • Update schedule data for a specific transport operation by ID
      • Get all phase data related to a specific transport operation by ID
      • Append phase data for a specific transport operation by ID
      • Get specific phase data by transport operation ID and phase ID
      • Update specific phase data by transport operation ID and phase ID
      • Get all international consignment notes related to a specific transport operation by ID
      • Append international consignment notes data for a specific transport operation by ID
      • Get specific international consignment notes data by transport operation ID and reference code
      • Update specific international consignment notes data by transport operation ID and reference code
      • Delete specific international consignment notes data by transport operation ID and reference code
      • Get specific transport operation data by country code and license plate number
      • Get details about the schedule of specific transport operation by country code and license plate number
      • Get details about all the phases of specific transport operation by country code and license plate number
      • Get specific phase data by country code, license plate number, and phase ID
      • Get all international consignment notes related to a specific transport operation by country code and license plate number
      • Get specific international consignment notes data by country code, license plate number, and reference code
    • Vehicle
      • Create new vehicle data
        POST
      • Get all vehicle data
        GET
      • Get vehicle data by country code and license plate number
        GET
      • Update vehicle data by country code and license plate number
        PUT
      • Delete specific vehicle data by country code and license plate number
        DELETE
      • Get details about the geolocation of vehicle by country code and license plate number
        GET
      • Append new vehicle's geolocation data by country code and license plate number
        PATCH
      • Get details about the owner of vehicle by country code and license plate number
        GET
      • Get details about the insurances of vehicle by country code and license plate number
        GET
      • Get details about the insurance of vehicle by country code, license plate number and insurance id
        GET
      • Get details about the revisions of vehicle by country code and license plate number
        GET
      • Get details about the revision of vehicle by country code, license plate number and revision id
        GET
    • Driver
      • Create new driver data
      • Get all driver data
      • Get driver data by country code and vat number
      • Update driver data by country code and vat number
      • Delete specific driver data
      • Get details about the driver's license by country code and vat number
      • Get details about the driver's traffic violations by country code and vat number
      • Get specific driver's traffic violation data by country code, vat number and traffic violation id
      • Get details about the driver's tachograph cards data by country code and vat number
      • Get specific driver's tachograph card data by country code, vat number and tachograph card id
  1. Vehicle

Get vehicle data by country code and license plate number

GET
/vehicles/{countryCode}/{plateNumber}/
Vehicle

Request

Path Params
countryCode
string 
required
Country code of the vehicle's registration.
plateNumber
string 
required
License plate number of the vehicle.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.company-server/v1/vehicles///'

Responses

🟢200OK
application/json
Vehicle data retrieved successfully
Body
Details about the vehicle used for the operation phase.
id
integer <int64>
required
Unique identifier for the vehicle.
>= 1
Example:
123456789
countryCode
string 
required
Country code of the vehicle's registration.
Example:
IT
Match pattern:
^[A-Z]{2,4}$
plateNumber
string 
required
License plate number of the vehicle.
>= 1 characters<= 20 characters
Example:
AA1232
type
string 
optional
Type of the vehicle.
>= 1 characters<= 20 characters
Example:
Truck
model
string 
optional
Model of the vehicle.
>= 1 characters<= 20 characters
Example:
XX Model
geolocation
array[object (Geolocation) {2}] 
optional
dateTime
string <date-time>
required
Date and time the vehicle was located at the given coordinates.
Example:
2023-06-25T10:00:00Z
Match pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
coordinates
object (Coordinates) 
required
Details about the coordinates.
owner
object (Owner) 
required
Details of the vehicle owner.
id
integer <int64>
required
Unique identifier for the vehicle.
>= 1
Example:
123456789
name
string 
required
Name of the company owning the vehicle.
>= 1 characters<= 20 characters
Example:
Acme Trucking
vat
string 
optional
VAT number of the vehicle owning company.
>= 2 characters<= 13 characters
Example:
IT2345678901
payload
object (Payload) 
optional
Additional information.
Example:
{"additionInformation":"Information XX"}
insurance
array[object (Insurance) {7}] 
required
List of vehicle's insurances.
id
integer <int64>
required
Unique identifier for the insurance of the vehicle.
>= 1
Example:
123456789
name
string 
required
Name of the insurance company.
>= 1 characters<= 20 characters
Example:
AB Insurance
number
string 
required
Insurance policy number.
>= 1 characters<= 20 characters
Example:
KST-123456789
isInsured
boolean 
required
Indicates whether the vehicle is insured.
Example:
true
activationDate
string <date>
required
Date when the vehicle insurance became active.
Example:
2023-01-15
Match pattern:
^\d{4}-\d{2}-\d{2}$
expirationDate
string <date>
required
Expiration date of the vehicle insurance.
Example:
2024-01-14
Match pattern:
^\d{4}-\d{2}-\d{2}$
payload
object (Payload) 
optional
Additional information.
Example:
{"additionInformation":"Information XX"}
revision
array[object (Revision) {6}] 
required
List of vehicle's revisions.
id
integer <int64>
required
Unique identifier for the revision of the vehicle.
>= 1
Example:
123456789
name
string 
required
Name of the revision company.
>= 1 characters<= 20 characters
Example:
Revision Comp
number
string 
required
Revision number.
>= 1 characters<= 20 characters
Example:
A-2211
executionDate
string <date>
required
Date when the vehicle revision became execute.
Example:
2023-01-15
Match pattern:
^\d{4}-\d{2}-\d{2}$
expirationDate
string <date>
required
Expiration date of the vehicle revision.
Example:
2024-01-14
Match pattern:
^\d{4}-\d{2}-\d{2}$
payload
object (Payload) 
optional
Additional information.
Example:
{"additionInformation":"Information XX"}
Example
{
  "id": 123456789,
  "countryCode": "IT",
  "plateNumber": "AA1232",
  "type": "Truck",
  "model": "XX Model",
  "geolocation": [
    {
      "dateTime": "2023-06-25T10:00:00Z",
      "coordinates": {
        "latitude": 34.052235,
        "longitude": -118.243683
      }
    }
  ],
  "owner": {
    "id": 123456789,
    "name": "Acme Trucking",
    "vat": "IT2345678901",
    "payload": {
      "additionInformation": "Information XX"
    }
  },
  "insurance": [
    {
      "id": 123456789,
      "name": "AB Insurance",
      "number": "KST-123456789",
      "isInsured": true,
      "activationDate": "2023-01-15",
      "expirationDate": "2024-01-14",
      "payload": {
        "additionInformation": "Information XX"
      }
    }
  ],
  "revision": [
    {
      "id": 123456789,
      "name": "Revision Comp",
      "number": "A-2211",
      "executionDate": "2023-01-15",
      "expirationDate": "2024-01-14",
      "payload": {
        "additionInformation": "Information XX"
      }
    }
  ]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Previous
Get all vehicle data
Next
Update vehicle data by country code and license plate number
Built with