Technical description xml-ocean-event

Ocean-Event-Message

Rationale

The Ocean Event Message has been designed to allow the processing of incoming container level tracking information from any external event-provider.

The message processing supports full-featured container level tracking. Meaning that the message will be processed in the same way as messages originating from a Riege partner integration.

Limitations

The set of events (event codes) supported by this message is limited by intention. Please reach out to service@riege.com if you think that an important type of event might be missing.

The interface supports incoming direction only, meaning that Scope can receive but will not create and send those messages.

Message Content

Root Element

<?xml version="1.0" encoding="UTF-8"?>
<oceanEventMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://dtd.riege.com/ocean-event/1.0" schemaVersion="1.0"/>

It is important to provide the xmlns and the schemaVersion inside the root element <oceanEventMessage>.

Header

<header>
  <sender>SENDERCODE</sender>
  <receiver>RECEIVERCODE</receiver>
  <messageId>ID1234567890</messageId>
  <messageTime>2023-02-05T12:01:00Z</messageTime>
</header>

The header contains

• the <sender>
• and <receiver> codes,
• a unique <messageId>
• and the message generation timestamp as <messageTime>.

All fields are mandatory.

FCL Event

The message allows to contain multiple events. In this case the <fclEvent> can repeat.

Attributes

<fclEvent code="EMPTY_PICKUP" containerNumber="MAEU1234567"
          scac="MAEU" iso6346="40OT"/>

The event code needs to be provided and has to be one of

• EMPTY_PICKUP
• POSITIONING
• PICKUP
• TERMINAL_IN
• TERMINAL_OUT
• ONBOARD
• DEPARTURE
• ARRIVAL
• DISCHARGE
• DELIVERY
• EMPTY_RETURN

Additionally, the following attributes to the <fclEvents> exist:

• containerNumber (mandatory)
• scac (mandatory)
• iso6346 to indicate the ISO Container-Type (optional)

Child Elements

<oceanEventMessage>
    <fclEvent>
    <creationTime>2023-02-05T12:01:00Z</creationTime>
    <eventTime type="actual">2023-02-05T12:01:00+01:00</eventTime>
    <eventLocation unlocode="DEHAM"/>
    <carrierReferences>
      <bl>123456</bl>
      <booking>123456</booking>
    </carrierReferences>
  </fclEvent>
</oceanEventMessage>

The <fclEvent> element contains the following child elements:

• <creationTime>: Time when the event has been created (mandatory)
• It can but does not have to be identical to the <messageTime> from the <header>
• <eventTime type="actual/estimate">: Time of the event (mandatory).
• Use type="actual" for events that have already occurred
• or type="estimate" to transmit a new estimate date and time.
• <eventLocation unlocode="DEHAM"/>: Event location as UNLOCode (mandatory)
• <carrierReferences>: Needs to contain at least one of these carrier references:
• <bl>: Ocean BL Number
• <booking>: Carrier Booking Number

Resources

XML Schema File

XSD Schema File

Examples

• scope_event.xml

Disclaimer: This technical description is not part of any contractual agreements.
This description is published by Riege Software under UPL license. Imprint. Privacy.
View project on GitHub