Ga naar inhoud

Ketenprotocol SB Datex-II V3

De beschrijving van de technische interface voor Situatieberichten is vastgelegd in het, in de onderliggende paragrafen beschreven, ketenprotocol-SB. Dit protocol is bedoeld om een beschrijving te geven hoe systemen voor de uitwisseling van DATEX II v3.x met elkaar verbinden en data met payload van het type situationPublication dienen uit te wisselen. Voor de uitwisseling wordt gebruik maakt van Exchange 2020. Er wordt gebruikt gemaakt van het zogenaamde Stateful Push protocol. Ten opzichte van het Europese protocol wordt op dit moment alleen delta Synchronization Push niet ondersteund. In de onderstaande voorbeelden wordt er vanuit gegaan dat NDW de leverancier is. Wanneer NDW de ontvanger is, komt dus op de plaats van 'NLNDW' in het element 'nationalIdentifier' het 'ID van de leverancier' te staan.

Uitwisseling van gegevens geschiedt op basis van SOAP (versie 1.1) over HTTP (versie 1.1). Voor de beschreven methode geldt dat er gebruik gemaakt moet worden van compressie om de hoeveelheid data verkeer te beperken. Hiervoor dient de HTTP header “Accept-Encoding: gzip” gebruikt te worden.

Payload

De payload bevat het daadwerkelijke DATEX II bericht met de situatie-informatie.

Exchange Information

De exchangeInformation gaat over de uitwisseling tussen de Supplier en de Client. Met behulp van informationManagement kunnen situaties beëindigd of geannuleerd worden. In de onderstaande paragrafen staan tabellen met verwijzingen als sd x.x.x. Dit verwijst zowel naar de onderdelen in de sequence diagrammen als naar de meegeleverde XML-voorbeelden.

Push Methode

Systemen binnen de SB keten hebben een interface beschikbaar om data te "pushen" naar een afnemende partij. Het systeem van deze partij moet gebouwd zijn om te werken met "Exchange 2020 Ketenprotocol WSDL".

1 WSDL-omschrijvingen zijn hier te vinden.

De push methode bevat een aantal onderdelen die hier onder beschreven worden. Het gaat om:

  • Administratie;
  • Start Connection and Deliver Data
  • Maintain Connection
  • Close Connection or Fail
  • Request Snapshot
  • Weigeren van data.

Administratie

Zowel de aanleverende (Supplier) als de afnemende (Client) partij houden een offline administratie bij. Hierin staat geregistreerd bij het aanleverend systeem:

  • AfnemerID
  • End Point waarop het afnemende systeem de data wil ontvangen;

Hierin staat geregistreerd bij het afnemende systeem:

  • LeverancierID
  • End Point waarop de het aanleverend systeem de registratie wil ontvangen.

Start Connection and Deliver Data

De client state is 'offline'. Het aanleverend systeem (Supplier) maakt kenbaar dat het klaar is voor levering door een openSession bericht te sturen naar het afnemend systeem.

sd 1.0 openSession

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus openingSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:openSessionInput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                              xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                              xmlns:com="http://datex2.eu/schema/3/common"
                              modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>openingSession</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-04T10:06:11.308965Z</ex:messageGenerationTimestamp>
            </ex:dynamicInformation>
        </stp:openSessionInput>
    </soap:Body>
</soap:Envelope>

Dit zal het aanleverende systeem elke 10 minuten doen net zolang tot het afnemende systeem reageert of tot dit handmatig overruled wordt.

Het afnemende systeem reageert op een van de drie volgende mogelijkheden:

  • Succes Snapshot on openSession
  • Succes Ack on openSession
  • Fail on openSession

Start connection

Succes Snapshot on openSession

In dit geval zal het afnemend systeem, wanneer het een Exchange openSession bericht ontvangt, een Exchange snapshotSynchronizationRequest bericht terugsturen, met daarin een Sessie ID, waarna het leverende systeem de client State naar 'online' zet.

sd 1.1.1 return snapshotSynchronizationRequest

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus openingSession
returnStatus snapshotSynchronisationRequest
sessionID Session ID, determined by client
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:openSessionOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                               xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                               xmlns:com="http://datex2.eu/schema/3/common"
                               modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>openingSession</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>snapshotSynchronisationRequest</ex:returnStatus>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:openSessionOutput>
    </soap:Body>
</soap:Envelope>

Hierna wordt er door het leverende systeem een snapshot gegenereerd wat met een ExchangeInformation(payloadDelivery) naar de afnemende partij wordt gestuurd. De gegevens bevinden zich in een payload van het type 'situationPublication'.

sd 1.1.2 payloadDelivery Snapshot

Elementen binnen payload
Alle relevante situaties situation

 

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
updateMethod snapshot
exchangeStatus online
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putSnapshotDataInput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                                  xmlns:mes="http://datex2.eu/schema/3/messageContainer"
                                  modelBaseVersion="3">
            <mes:payload xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                         xmlns:com="http://datex2.eu/schema/3/common"
                         xmlns:sit="http://datex2.eu/schema/3/situation"
                         xmlns:loc="http://datex2.eu/schema/3/location"
                         xsi:type="sit:SituationPublication" lang="nl" modelBaseVersion="3">
            ....
            </mes:payload>
            <mes:exchangeInformation xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                                     modelBaseVersion="3">
                <ex:exchangeContext>
                    <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                    <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                    <ex:updateMethod>snapshot</ex:updateMethod>
                    <ex:supplierOrCisRequester>
                        <ex:internationalIdentifier>
                            <com:country>NL</com:country>
                            <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                        </ex:internationalIdentifier>
                   </ex:supplierOrCisRequester>
                </ex:exchangeContext>
                <ex:dynamicInformation>
                    <ex:exchangeStatus>online</ex:exchangeStatus>
                    <ex:messageGenerationTimestamp>2021-08-11T07:56:57.374114Z</ex:messageGenerationTimestamp>
                    <ex:sessionInformation>
                        <ex:sessionID>7892634986</ex:sessionID>
                    </ex:sessionInformation>
                </ex:dynamicInformation>
            </mes:exchangeInformation>
        </stp:putSnapshotDataInput>
    </soap:Body>
</soap:Envelope>

Het ontvangende systeem reageert met een 'ack'-bericht dat het snapshot correct is ontvangen.

sd 1.1.3 return ack

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus Online
returnStatus Ack
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putSnapshotDataOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                                   xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                                   xmlns:com="http://datex2.eu/schema/3/common"
                                   modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>ack</ex:returnStatus>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:putSnapshotDataOutput>
    </soap:Body>
</soap:Envelope>

Hierna gaat het leverende systeem uit de loop 'Supplier Status offline Open Session' en gaat deze naar het volgende sequence diagram 'Maintain Connection' (zie het volgende hoofdstuk).

Fail on openSession

Wanneer het afnemend systeem een fail terugstuurt op de openSession of er helemaal geen antwoord komt, blijft het aanleverende systeem elke tien minuten proberen een verbinding op te zetten.

sd 1.2.1 return fail

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus openingSession
returnStatus fail
returnStatusReason optionele extra informatie
codedInvalidityReason bv: other
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:openSessionOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                               xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                               xmlns:com="http://datex2.eu/schema/3/common"
                               modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>openingSession</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>fail</ex:returnStatus>
                    <ex:returnStatusReason>
                        <com:values>
                            <com:value>optional extra reason information</com:value>
                        </com:values>
                    </ex:returnStatusReason>
                    <ex:codedInvalidityReason>other</ex:codedInvalidityReason>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:openSessionOutput>
    </soap:Body>
</soap:Envelope>

Maintain Connection

De verbinding tussen het aanleverend systeem en het afnemend systeem zal worden onderhouden door het aanleverend systeem. Er zijn twee scenarios: 'Data Ready for Payload Push' en 'no data keepAlive'

Maintain connection

Data ready for payload push

Wanneer er binnen één minuut na het laatst verstuurde bericht er een update op de data is zal deze direct verstuurd worden door middel van een allElementUpdate bericht waarbij de data zich bevindt in een payload van het type situationPublication.

sd 2.1.1 allElementUpdate

Elementen binnen payload
Alle geüpdatete situaties situation
Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
operatingMode onOccurence
updateMethod allElementUpdate
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus online
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putDataInput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                          xmlns:mes="http://datex2.eu/schema/3/messageContainer"
                          modelBaseVersion="3">
            <mes:payload xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                         xmlns:com="http://datex2.eu/schema/3/common"
                         xmlns:sit="http://datex2.eu/schema/3/situation"
                         xmlns:loc="http://datex2.eu/schema/3/location"
                         xsi:type="sit:SituationPublication" lang="nl" modelBaseVersion="3">
            ...
            </mes:payload>
            <mes:exchangeInformation xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                                     modelBaseVersion="3">
                <ex:exchangeContext>
                    <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                    <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                    <ex:operatingMode>onOccurrence</ex:operatingMode>
                    <ex:updateMethod>allElementUpdate</ex:updateMethod>
                    <ex:supplierOrCisRequester>
                        <ex:internationalIdentifier>
                            <com:country>NL</com:country>
                            <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                        </ex:internationalIdentifier>
                    </ex:supplierOrCisRequester>
                </ex:exchangeContext>
                <ex:dynamicInformation>
                    <ex:exchangeStatus>online</ex:exchangeStatus>
                    <ex:messageGenerationTimestamp>2021-08-11T07:56:57.374114Z</ex:messageGenerationTimestamp>
                    <ex:sessionInformation>
                       <ex:sessionID>7892634986</ex:sessionID>
                   </ex:sessionInformation>
                </ex:dynamicInformation>
            </mes:exchangeInformation>
        </stp:putDataInput>
    </soap:Body>
</soap:Envelope>

sd 2.1.2 return ack

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus online
returnStatus ack
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putDataOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                           xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                           xmlns:com="http://datex2.eu/schema/3/common"
                           modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>Exchange2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>ack</ex:returnStatus>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:putDataOutput>
    </soap:Body>
</soap:Envelope>

No data keepAlive

Wanneer er één minuut na het versturen van het laatste bericht nog geen update op de data te versturen is, zal het aanleverende systeem een keep-alive bericht sturen. Dit zal het systeem elke minuut blijven doen totdat er een update op de data is en er een allElementUpdate verstuurd wordt (de vorige paragraaf).

sd 2.2.1 keepAlive

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus online
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:keepAliveInput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                            xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                            xmlns:com="http://datex2.eu/schema/3/common"
                            modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-04T10:06:11.308965Z</ex:messageGenerationTimestamp>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:keepAliveInput>
    </soap:Body>
</soap:Envelope>

sd 2.2.2 return ack

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus online
returnStatus ack
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:keepAliveOutput  xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                              xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                              xmlns:com="http://datex2.eu/schema/3/common"
                              modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>ack</ex:returnStatus>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:keepAliveOutput>
    </soap:Body>
</soap:Envelope>

CloseSession or Fail

Wanneer het ontvangende systeem de verbinding wil verbreken, dient deze een closeSessionRequest sturen als reactie op een pushbericht of een keepAlive-bericht. Het aanleverende systeem reageert dan met een closeSession bericht. Het ontvangende systeem reageert hetzelfde wanneer een bericht geweigerd wordt door het ontvangende systeem (fail).

Ook wanneer het ontvangende systeem voor een timeout zorgt bij het aanleverende systeem, zal het aanleverende systeem een closeSession sturen.

Het aanleverende systeem zal na bevestiging of timeout de sessie naar 'offline' zetten, zo wordt de verbinding inactief en zal er geen data meer verstuurd worden.

Close session

sd 3.1 return closeSessionRequest

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion Exchange 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus closingSession
returnStatus closeSessionRequest
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld closeSessionRequest na putDataInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putDataOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                           xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                           xmlns:com="http://datex2.eu/schema/3/common"
                           modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>closingSession</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>closeSessionRequest</ex:returnStatus>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:putDataOutput>
    </soap:Body>
</soap:Envelope>
XML Voorbeeld closeSessionRequest na putSnapshotDataInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putSnapshotDataOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                                   xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                                   xmlns:com="http://datex2.eu/schema/3/common"
                                   modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>closingSession</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>closeSessionRequest</ex:returnStatus>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:putSnapshotDataOutput>
    </soap:Body>
</soap:Envelope>
XML Voorbeeld closeSessionRequest na keepAliveInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:keepAliveOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                             xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                             xmlns:com="http://datex2.eu/schema/3/common"
                             modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>closingSession</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>closeSessionRequest</ex:returnStatus>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:keepAliveOutput>
    </soap:Body>
</soap:Envelope>

sd 3.2 return fail

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus online
returnStatus fail
returnStatusReason Optionele toelichting
codedInvalidityReason bv: invalidMessage
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld na putDataInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putDataOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                           xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                           xmlns:com="http://datex2.eu/schema/3/common"
                          modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>fail</ex:returnStatus>
                    <ex:returnStatusReason>
                        <com:values>
                            <com:value>XSD validation error at: line 110</com:value>
                        </com:values>
                    </ex:returnStatusReason>
                    <ex:codedInvalidityReason>invalidMessage</ex:codedInvalidityReason>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:putDataOutput>
    </soap:Body>
</soap:Envelope>
XML Voorbeeld na putSnapshotDataInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putSnapshotDataOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                                   xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                                   xmlns:com="http://datex2.eu/schema/3/common"
                                   modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>fail</ex:returnStatus>
                    <ex:returnStatusReason>
                        <com:values>
                            <com:value>XSD validation error at: line 110</com:value>
                        </com:values>
                    </ex:returnStatusReason>
                    <ex:codedInvalidityReason>invalidMessage</ex:codedInvalidityReason>
                </ex:returnInformation>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
            </ex:dynamicInformation>
        </stp:putSnapshotDataOutput>
    </soap:Body>
</soap:Envelope>

sd 3.3 closeSession

Elementen binnen exchangeInformation Waarde
messageType closeSession
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus closingSession
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:closeSessionInput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                               xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                               xmlns:com="http://datex2.eu/schema/3/common"
                               modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>closingSession</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-04T10:06:11.308965Z</ex:messageGenerationTimestamp>
                <ex:sessionInformation>
                    <ex:sessionID>7892634986</ex:sessionID>
                </ex:sessionInformation>
           </ex:dynamicInformation>
        </stp:closeSessionInput>
    </soap:Body>
</soap:Envelope>

sd 3.4 return ack

Elementen binnen exchangeInformation Waarde
messageType return
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus offline
returnStatus ack
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:closeSessionOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                                xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                                xmlns:com="http://datex2.eu/schema/3/common"
                                modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>offline</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>ack</ex:returnStatus>
                </ex:returnInformation>
            </ex:dynamicInformation>
        </stp:closeSessionOutput>
    </soap:Body>
</soap:Envelope>

Snapshot Request

Wanneer een ontvangend systeem, om wat voor reden dan ook, een snapshot nodig heeft om de huidige situatie weer te weten, kan deze op elk bericht een return bericht sturen met een snapshotSynchronizationRequest. Het aanleverende systeem zal als gevolg van dit verzoek een snapshot genereren en daarna deze naar het ontvangende systeem sturen en daarna doorgaan met de 'maintain Connection'. Dit verzoek kan alleen plaats vinden wanneer de session op 'online' staat. Anders moet eerst de verbinding weer opgezet worden.

Request snapshot

sd 4.1 return snapshotSynchronizationRequest

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
exchangeStatus online
returnStatus snapshotSynchronisationRequest
XML Voorbeeld na keepAliveInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:keepAliveOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                             xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                             xmlns:com="http://datex2.eu/schema/3/common"
                            modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>snapshotSynchronisationRequest</ex:returnStatus>
                </ex:returnInformation>
            </ex:dynamicInformation>
        </stp:keepAliveOutput>
    </soap:Body>
</soap:Envelope>
XML Voorbeeld na openSessionInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:openSessionOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                               xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                               xmlns:com="http://datex2.eu/schema/3/common"
                               modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>snapshotSynchronisationRequest</ex:returnStatus>
                </ex:returnInformation>
            </ex:dynamicInformation>
        </stp:openSessionOutput>
    </soap:Body>
</soap:Envelope>
XML Voorbeeld na putDataInput 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putDataOutput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                           xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                           xmlns:com="http://datex2.eu/schema/3/common"
                           modelBaseVersion="3">
            <ex:exchangeContext>
                <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                <ex:supplierOrCisRequester>
                    <ex:internationalIdentifier>
                        <com:country>NL</com:country>
                        <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                    </ex:internationalIdentifier>
                </ex:supplierOrCisRequester>
            </ex:exchangeContext>
            <ex:dynamicInformation>
                <ex:exchangeStatus>online</ex:exchangeStatus>
                <ex:messageGenerationTimestamp>2021-03-17T19:56:16.266+01:00</ex:messageGenerationTimestamp>
                <ex:returnInformation>
                    <ex:returnStatus>snapshotSynchronisationRequest</ex:returnStatus>
                </ex:returnInformation>
            </ex:dynamicInformation>
        </stp:putDataOutput>
    </soap:Body>
</soap:Envelope>

Hierna wordt er door het leverende systeem een snapshot met alle relevante situations gegenereerd dat samen met een ExchangeInformation(payloadDelivery) naar de afnemende partij wordt gestuurd. De gegevens bevinden zich in een payload van het type 'situationPublication'.

sd 4.2 payloadDelivery Snapshot

Elementen binnen payload
Alle relevante situaties situation

 

Elementen binnen exchangeInformation Waarde
codedExchangeProtocol statefulPush
exchangeSpecificationVersion 2020
supplierOrCisRequester internationalIdentifier Land, en ID van leverancier
updateMethod snapshot
exchangeStatus online
sessionID Session ID, previously obtained with OpenSession
XML Voorbeeld 
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <stp:putSnapshotDataInput xmlns:stp="http://datex2.eu/wsdl/statefulPush/2020"
                                  xmlns:mes="http://datex2.eu/schema/3/messageContainer"
                                  modelBaseVersion="3">
            <mes:payload xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                         xmlns:com="http://datex2.eu/schema/3/common"
                         xmlns:sit="http://datex2.eu/schema/3/situation"
                         xmlns:loc="http://datex2.eu/schema/3/location"
                         xsi:type="sit:SituationPublication" lang="nl" modelBaseVersion="3">
            ....
            </mes:payload>
            <mes:exchangeInformation xmlns:ex="http://datex2.eu/schema/3/exchangeInformation"
                                     modelBaseVersion="3">
                <ex:exchangeContext>
                    <ex:codedExchangeProtocol>statefulPush</ex:codedExchangeProtocol>
                    <ex:exchangeSpecificationVersion>2020</ex:exchangeSpecificationVersion>
                    <ex:updateMethod>snapshot</ex:updateMethod>
                    <ex:supplierOrCisRequester>
                        <ex:internationalIdentifier>
                            <com:country>NL</com:country>
                            <com:nationalIdentifier>NLNDW</com:nationalIdentifier>
                        </ex:internationalIdentifier>
                   </ex:supplierOrCisRequester>
                </ex:exchangeContext>
                <ex:dynamicInformation>
                    <ex:exchangeStatus>online</ex:exchangeStatus>
                    <ex:messageGenerationTimestamp>2021-08-11T07:56:57.374114Z</ex:messageGenerationTimestamp>
                    <ex:sessionInformation>
                        <ex:sessionID>7892634986</ex:sessionID>
                    </ex:sessionInformation>
                </ex:dynamicInformation>
            </mes:exchangeInformation>
        </stp:putSnapshotDataInput>
    </soap:Body>
</soap:Envelope>

Het ontvangende systeem reageert met een 'ack'-bericht dat het snapshot correct is ontvangen.

InformationManagement

In het geval van situatie publicaties worden met behulp van het informationManagement situaties en situatieonderdelen beëindigd of geannuleerd. Dit geldt voor zowel de individuele situationRecords als voor de situation waar de situationRecords onderdeel van zijn. Dit betekent op het moment dat een event wordt beëindigd, aanvullend op het informationManagement onderdeel ook de payload nog één maal wordt verstuurd. Op dat moment wordt ook de definitieve eindtijd van het event opgenomen in het validity-onderdeel overallEndTime.

Voorbeeld:

XML Voorbeeld beëindigd 
<?xml version="1.0" encoding="UTF-8"?>
  <informationManagement>
    <inf:informationManagedResourceList>
      <inf:elementReference>
        <managementStatus xmlns="http://datex2.eu/schema/3/informationManagement">closed</managementStatus>
        <reference xmlns="http://datex2.eu/schema/3/informationManagement" id="NDW03_WW_RWKSID_1_249390738" />
      </inf:elementReference>
    </inf:informationManagedResourceList>
</informationManagement>
XML Voorbeeld geannuleerd 
<?xml version="1.0" encoding="UTF-8"?>
  <informationManagement>
    <inf:informationManagedResourceList>
      <inf:elementReference>
        <managementStatus xmlns="http://datex2.eu/schema/3/informationManagement">cancelled</managementStatus>
        <reference xmlns="http://datex2.eu/schema/3/informationManagement" id="NDW03_WW_RWKSID_1_249390738" />
      </inf:elementReference>
    </inf:informationManagedResourceList>
</informationManagement>
Ga terug naar de vorige pagina