KEYSTONE API Standard
  1. Transport Operation
KEYSTONE API Standard
  • Overview
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
  • Paths
    • Transport Operation
      • Create new transport operation data
        POST
      • Get all ongoing transport operation data
        GET
      • Get a specific transport operation data by ID
        GET
      • Update data for a specific transport operation by ID
        PUT
      • Delete specific transport operation data by ID
        DELETE
      • Get schedule data related to a specific transport operation by ID
        GET
      • Update schedule data for a specific transport operation by ID
        PUT
      • Get all phase data related to a specific transport operation by ID
        GET
      • Append phase data for a specific transport operation by ID
        PATCH
      • Get specific phase data by transport operation ID and phase ID
        GET
      • Update specific phase data by transport operation ID and phase ID
        PUT
      • Get all international consignment notes related to a specific transport operation by ID
        GET
      • Append international consignment notes data for a specific transport operation by ID
        PATCH
      • Get specific international consignment notes data by transport operation ID and reference code
        GET
      • Update specific international consignment notes data by transport operation ID and reference code
        PUT
      • Delete specific international consignment notes data by transport operation ID and reference code
        DELETE
      • Get ongoing transport operation data by country code and license plate number
        GET
      • Get details about the schedule of the ongoing transport operation by country code and license plate number
        GET
      • Get details about all the phases of the ongoing transport operation by country code and license plate number
        GET
      • Get specific phase data related to the ongoing transport operation by country code, license plate number, and phase ID
        GET
      • Get all international consignment notes related to the ongoing transport operation by country code and license plate number
        GET
      • Get specific international consignment notes data related to the ongoing transport operation by country code, license plate number, and reference code
        GET
      • Get all locations related to transport operations
        GET
      • Get all locations related to transport operations by location mode
        GET
    • Vehicle
      • Create new vehicle data
      • Get all vehicle data
      • Get vehicle data by country code and license plate number
      • Update vehicle data by country code and license plate number
      • Delete specific vehicle data by country code and license plate number
      • Get details about the geolocation of vehicle by country code and license plate number
      • Append new vehicle's geolocation data by country code and license plate number
      • Get details about the owner of vehicle by country code and license plate number
      • Get details about the insurances of vehicle by country code and license plate number
      • Get details about the insurance of vehicle by country code, license plate number and insurance id
      • Get details about the revisions of vehicle by country code and license plate number
      • Get details about the revision of vehicle by country code, license plate number and revision id
    • 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. Transport Operation

Get details about the schedule of the ongoing transport operation by country code and license plate number

GET
https://api.company-server/v1/transport-operations/{countryCode}/{plateNumber}/schedules/
Transport Operation

Request

Path Params
countryCode
string 
required
Country code of the vehicle's registration.
Match pattern:
^[A-Z]{2,4}$
plateNumber
string 
required
License plate number of the vehicle.
Match pattern:
^[\s\S]{1,20}$

Responses

🟢200OK
application/json
Schedule data retrieved successfully
Body
Details about the date and time of transport operation.
departureDateTime
string <date-time>
required
Predefined date and time of departure.
Example:
2023-06-25T10:00:00Z
Match pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
realDepartureDateTime
string <date-time>
optional
Real date and time of departure.
Example:
2023-06-27T10:30:00Z
Match pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
estimatedDateTimeOfArrival
string <date-time>
required
Estimated date and time of arrival.
Example:
2023-06-27T17:00:00Z
Match pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
realArrivalDateTime
string <date-time>
optional
Real date and time of arrival.
Example:
2023-06-27T17:20:00Z
Match pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
Example
{
    "departureDateTime": "2023-06-25T10:00:00Z",
    "realDepartureDateTime": "2023-06-27T10:30:00Z",
    "estimatedDateTimeOfArrival": "2023-06-27T17:00:00Z",
    "realArrivalDateTime": "2023-06-27T17:20:00Z"
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Previous
Get ongoing transport operation data by country code and license plate number
Next
Get details about all the phases of the ongoing transport operation by country code and license plate number
Built with