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

Get all vehicle data

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

Request

None

Responses

🟢200OK
application/json
Vehicle data retrieved successfully
Body

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"
                }
            }
        ]
    }
]
🟠404Record Not Found
🔴500Server Error
Previous
Create new vehicle data
Next
Get vehicle data by country code and license plate number
Built with