Skip to content

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.

Download OpenAPI description
transport-realisation.json
transport-realisation.yaml
Overview
Languages
Servers
Mock server
https://developer.simacan.com/_mock/openapi/realisation/transport-realisation/
Production Environment
https://transport-realisation-receiver.services.simacan.com/api/public/
Staging Environment
https://transport-realisation-receiver-stg.services.simacan.com/api/public/

Realisation update

Request

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

Security
BearerAuth
Path
shipper_codestringrequired

Unique shipper code as provided by Simacan

carrier_codestringrequired

Unique carrier code as provided by Simacan

Bodyapplication/xmlrequired
realisationobject
curl -i -X POST \
  'https://developer.simacan.com/_mock/openapi/realisation/transport-realisation/{shipper_code}/transporter/v2/{carrier_code}/realisation' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/xml' \
  -d '<realisation xmlns="http://www.simacan.com/schemas/rct/transporter/v2/realisation">
    <tripRealisation>
      <tripId>123456</tripId>
      <timestamp>2020-12-31T14:13:22.11823+01:00</timestamp>
      <activity>RIJDEN</activity>
      <heading>180</heading>
      <mileage>209923.27</mileage>
      <speed>75</speed>
      <x>4.89145</x>
      <y>52.37376</y>
      <root>
        <trailerId>508818951RR</trailerId>
        <licensePlate>12-ABC-3</licensePlate>
      </root>
    </tripRealisation>
  </realisation>
  '

Responses

The post message has been successfully processed

Bodytext/plain
string

success message

Response
text/plain
Successfully received {messages.length} updates