KEYSTONE API Standard
  1. Vehicle
KEYSTONE API Standard
  • Overview
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
  • Paths
    • Transport Operation
      • Create new transport operation data
      • Get all ongoing 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 ongoing transport operation data by country code and license plate number
      • Get details about the schedule of the ongoing transport operation by country code and license plate number
      • Get details about all the phases of the ongoing transport operation by country code and license plate number
      • Get specific phase data related to the ongoing transport operation by country code, license plate number, and phase ID
      • Get all international consignment notes related to the ongoing transport operation by country code and license plate number
      • Get specific international consignment notes data related to the ongoing transport operation by country code, license plate number, and reference code
      • Get all locations related to transport operations
      • Get all locations related to transport operations by location mode
    • 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

Create new vehicle data

POST
https://api.company-server/v1/vehicles/

Request

Body Params application/json
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.
Example:
AA1232
Match pattern:
^[\s\S]{1,20}$
type
string 
optional
Type of the vehicle.
Example:
Truck
Match pattern:
^[\s\S]{1,20}$
model
string 
optional
Model of the vehicle.
Example:
XX Model
Match pattern:
^[\s\S]{1,20}$
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.
Example:
Acme Trucking
Match pattern:
^[\s\S]{1,20}$
vat
string 
optional
VAT number of the vehicle owning company.
Example:
IT2345678901
Match pattern:
^[\s\S]{2,13}$
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.
Example:
AB Insurance
Match pattern:
^[\s\S]{1,20}$
number
string 
required
Insurance policy number.
Example:
KST-123456789
Match pattern:
^[\s\S]{1,20}$
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.
Example:
Revision Comp
Match pattern:
^[\s\S]{1,20}$
number
string 
required
Revision number.
Example:
A-2211
Match pattern:
^[\s\S]{1,20}$
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": 5151611656125,
    "countryCode": "IT",
    "plateNumber": "AA1232",
    "type": "Truck",
    "model": "Model X",
    "geolocation": [
        {
            "dateTime": "2023-06-25T10:00:00Z",
            "coordinates": {
                "latitude": 44.43280249569422,
                "longitude": 8.96079325815954
            }
        },
        {
            "dateTime": "2023-06-25T10:00:05Z",
            "coordinates": {
                "latitude": 44.43333558887465,
                "longitude": 8.959854986839684
            }
        }
    ],
    "owner": {
        "id": 566554511871,
        "name": "Acme Trucking",
        "vat": "IT2345678901"
    },
    "insurance": [
        {
            "id": 778554845525,
            "name": "AB Insurance",
            "number": "KST-123456789",
            "isInsured": true,
            "activationDate": "2023-01-15",
            "expirationDate": "2024-01-14"
        }
    ],
    "revision": [
        {
            "id": 2232355445,
            "name": "Revision Comp",
            "number": "A-2211",
            "executionDate": "2023-01-15",
            "expirationDate": "2024-01-14"
        }
    ]
}

Responses

🟢201Created
application/json
Vehicle data created 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.
Example:
AA1232
Match pattern:
^[\s\S]{1,20}$
type
string 
optional
Type of the vehicle.
Example:
Truck
Match pattern:
^[\s\S]{1,20}$
model
string 
optional
Model of the vehicle.
Example:
XX Model
Match pattern:
^[\s\S]{1,20}$
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.
Example:
Acme Trucking
Match pattern:
^[\s\S]{1,20}$
vat
string 
optional
VAT number of the vehicle owning company.
Example:
IT2345678901
Match pattern:
^[\s\S]{2,13}$
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.
Example:
AB Insurance
Match pattern:
^[\s\S]{1,20}$
number
string 
required
Insurance policy number.
Example:
KST-123456789
Match pattern:
^[\s\S]{1,20}$
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.
Example:
Revision Comp
Match pattern:
^[\s\S]{1,20}$
number
string 
required
Revision number.
Example:
A-2211
Match pattern:
^[\s\S]{1,20}$
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": 5151611656125,
    "countryCode": "IT",
    "plateNumber": "AA1232",
    "type": "Truck",
    "model": "Model X",
    "geolocation": [
        {
            "dateTime": "2023-06-25T10:00:00Z",
            "coordinates": {
                "latitude": 44.43280249569422,
                "longitude": 8.96079325815954
            }
        },
        {
            "dateTime": "2023-06-25T10:00:05Z",
            "coordinates": {
                "latitude": 44.43333558887465,
                "longitude": 8.959854986839684
            }
        }
    ],
    "owner": {
        "id": 566554511871,
        "name": "Acme Trucking",
        "vat": "IT2345678901"
    },
    "insurance": [
        {
            "id": 778554845525,
            "name": "AB Insurance",
            "number": "KST-123456789",
            "isInsured": true,
            "activationDate": "2023-01-15",
            "expirationDate": "2024-01-14"
        }
    ],
    "revision": [
        {
            "id": 2232355445,
            "name": "Revision Comp",
            "number": "A-2211",
            "executionDate": "2023-01-15",
            "expirationDate": "2024-01-14"
        }
    ]
}
🟠400Bad Request
🔴500Server Error
Previous
Vehicle
Next
Get all vehicle data
Built with