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

Append phase data for a specific transport operation by ID

PATCH
https://api.company-server/v1/transport-operations/{transportOperationId}/phases/

Request

Path Params
transportOperationId
integer <int64>
required
Unique identifier for the transport operation.
Body Params application/json
Details about the operation phase.
id
integer <int32>
required
The indicator of the respective operation phase.
>= 1
Example:
1
location
object (Location) 
required
Details about the location.
id
integer <int64>
required
Unique identifier for the location.
>= 1
Example:
123456789
description
string 
required
Description about the location.
Example:
Place X
Match pattern:
^[\s\S]{1,100}$
mode
enum<string> 
required
Details about the mode of the location.
Allowed values:
GENERICGATETERMINALPORTAIRPORTSTATION
Example:
GENERIC
coordinates
object (Coordinates) 
optional
Details about the coordinates.
dateTime
string <date-time>
required
Date and time of the respective operation phase.
Example:
2023-06-25T10:00:00Z
Match pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
state
enum<string> 
required
Details about the state of the operation phase.
Allowed values:
PLANNINGIN_PROGRESSARRIVED_AT_PICKUPARRIVED_AT_DESTINATIONLOADINGUNLOADINGIN_TRANSITCOMPLETEDDELAYEDCANCELED
Example:
IN_TRANSIT
payload
object (Payload) 
optional
Additional information.
Example:
{"additionInformation":"Information XX"}
Additional properties
integer  | number  | string  | boolean 
optional
Example
{
    "id": 1,
    "location": {
        "id": 123456789,
        "description": "Place X",
        "mode": "GENERIC",
        "coordinates": {
            "latitude": 34.052235,
            "longitude": -118.243683
        }
    },
    "dateTime": "2023-06-25T10:00:00Z",
    "state": "PLANNING",
    "payload": {
        "additionInformation": "Information XX"
    }
}

Responses

🟢200OK
application/json
Phase data appended successfully
Body
Details about the operation phase.
id
integer <int32>
required
The indicator of the respective operation phase.
>= 1
Example:
1
location
object (Location) 
required
Details about the location.
id
integer <int64>
required
Unique identifier for the location.
>= 1
Example:
123456789
description
string 
required
Description about the location.
Example:
Place X
Match pattern:
^[\s\S]{1,100}$
mode
enum<string> 
required
Details about the mode of the location.
Allowed values:
GENERICGATETERMINALPORTAIRPORTSTATION
Example:
GENERIC
coordinates
object (Coordinates) 
optional
Details about the coordinates.
dateTime
string <date-time>
required
Date and time of the respective operation phase.
Example:
2023-06-25T10:00:00Z
Match pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
state
enum<string> 
required
Details about the state of the operation phase.
Allowed values:
PLANNINGIN_PROGRESSARRIVED_AT_PICKUPARRIVED_AT_DESTINATIONLOADINGUNLOADINGIN_TRANSITCOMPLETEDDELAYEDCANCELED
Example:
IN_TRANSIT
payload
object (Payload) 
optional
Additional information.
Example:
{"additionInformation":"Information XX"}
Additional properties
integer  | number  | string  | boolean 
optional
Example
{
    "id": 1,
    "location": {
        "id": 123456789,
        "description": "Place X",
        "mode": "GENERIC",
        "coordinates": {
            "latitude": 34.052235,
            "longitude": -118.243683
        }
    },
    "dateTime": "2023-06-25T10:00:00Z",
    "state": "PLANNING",
    "payload": {
        "additionInformation": "Information XX"
    }
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Previous
Get all phase data related to a specific transport operation by ID
Next
Get specific phase data by transport operation ID and phase ID
Built with