Transport Realisation API (1.0)

This service aims to receive trip based realization data for our customers, in order to update the actual status of a trip in the Control Tower.

Realisation update

The realisation endpoint enables you to send realisation data for a specific trip

SecurityBearerAuth
Request
path Parameters
shipper_code
required
string

Unique shipper code as provided by Simacan

carrier_code
required
string

Unique carrier code as provided by Simacan

Request Body schema: application/xml
object
required
object
tripId
required
string

Unique reference for this trip

timestamp
required
string <date-time>

Timestamp when record was created

activity
string

A choice of activity

Enum: "LADEN" "LOSSEN" "WACHTEN" "PAUZE" "TANKEN" "WASSEN" "RIJDEN" "FILE" "KOPPELEN" "VEERBOOT"
heading
number <double> [ 0 .. 360 ]

Amount in degrees the vehicle is heading to

mileage
number <double> >= 0

Mileage for the vehicle

speed
number

Speed of the vehicle in kilometers per hour

x
number <double>

X-coordinate or longitude of the vehicle

y
number <double>

Y-coordinate or longitude of the vehicle

Array of objects (trailer)
Array
trailerId
string

Unique id for the trailer

licensePlate
string

License plate for the trailer

Responses
200

The post message has been successfully processed

400

The request was invalid or cannot be otherwise served. Possible causes are invalid XML or missing required parameters. An accompanying error message will explain further.

401

Authentication credentials were missing or incorrect.

403

The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why.

404

The URI requested is invalid or the resource requested does not exists. Also returned when the requested format is not supported by the requested method.

post/{shipper_code}/transporter/v2/{carrier_code}/realisation
Request samples
application/xml
<?xml version="1.0" encoding="utf-8"?>
<realisation xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.simacan.com/schemas/rct/transporter/v2/realisation">
  <tripRealisation xmlns="">
    <tripId>123456</tripId>
    <timestamp>2020-12-31T14:13:22.11823+01:00</timestamp>
    <heading>180</heading>
    <speed>75</speed>
    <x>4.89145</x>
    <y>52.37376</y>
  </tripRealisation>
</realisation>
Response samples
text/plain
Successfully received {messages.length} updates