Element Exchange

Het element exchange wordt gebruikt om parameters uit te wisselen die gerelateerd zijn aan de levering, zoals de details van de toeleverende partij en het type van het bericht. De opbouw is als volgt:

Elementen

Element	Type	Verplicht	Domein	Omschrijving
deliverybreak	Boolean	Enkel als het aanleverende systeem klaar is voor levering, maar er nog geen aanmelding heeft plaatsgevonden	true, false	Geeft binnen het ketenprotocol voor statusgegevens aan wanneer er nog niet aangemeld is, of wanneer een bericht niet afgeleverd kan worden
denyReason	DenyReasonEnum	Dit element is verplicht op het moment dat het element response gevuld is met “requestDenied”. Het element is niet toegestaan op het moment dat het element response een andere waarde dan “requestDenied” heeft	unknownReason, wrongPartner	Geeft de reden aan waarom gegevens niet goed ontvangen zijn
exchangeExtension	ExchangeExtension	Nee	NVT	Extensie ten behoeve van aanvullende informatie over de reden van een foutsituatie bij gegevensuitwisseling
keepAlive	Boolean	Enkel in Keep-Alive berichten binnen het ketenprotocol	true, false	Element wordt gebruikt om aan te geven dat of dit een Keep-alive bericht betreft
response	ResponseEnum	Enkel in een antwoordbericht binnen het ketenprotocol	acknowledge, requestDenied	Bevat het resultaat van de ontvangst van de gegevens
supplierIdentification	InternationalIdentifier	Ja	NVT	Containerelement met informatie over de aanleverende partij van informatie
subscription	Subscription	Nee	NVT	Het element subscription wordt gebruikt om de ontvangende partij op de hoogte te stellen van de status van de verbinding

Toelichting denyReason

Met dit element kan de reden waarom gegevens niet goed ontvangen of verwerkt zijn worden aangegeven. Dit element is verplicht op het moment dat het element response gevuld is met “requestDenied”. Het element is niet toegestaan op het moment dat het element response een andere waarde dan “requestDenied” heeft. Het domein van dit element is als volgt:

• wrongPartner: Indien er geprobeerd wordt verbinding te maken met de verkeerde identificatie.

• unknownReason: Indien het bericht geweigerd wordt. Aanvullende reden kan opgegeven worden met de extensie denyReasonExtension.

Zie voor nadere toelichting ook de toelichting op het ketenprotocol.

Subelement exchangeExtension

Het element exchangeExtension is een extensie om de class exchange uit te breiden. Het element bevat een element: denyReasonExtension.

Subelement denyReasonExtension

Het element exchangeExtension is een extensie om het gebruik van denyReason uit te breiden. Dit element bevat twee elementen, het verplichte element denyReasonExtension, en het optionele element denyReasonDescription. Wanneer denyReasonExtension gebruikt wordt is beschreven in de toelichting op het ketenprotocol.

Sublement	Type	Verplicht	Domein	Omschrijving
denyReasonExtension	DenyReasonExtensionEnum	Ja	invalidXML,unExpectedPubSize, invalidConfigurationReference, conditionalValidationFailed,otherReason
denyReasonDescription	MultilingualString	Nee	NVT	Tekstuele omschrijving van de reden voor weigering van het bericht

Element denyReasonExtension

Dit element bevat de reden waarom een bericht geweigerd is. Het bereik voor dit element is als volgt.

• invalidXML: XML niet valide volgens Nederland profiel (XSD)

• unExpectedPubSize (alleen bij de MeasurementSiteTable publicatie): Bericht grootte veschilt van de verwachtte grootte die gebaseerd is op afspraken tussen de leverende en de ontvangende partij.

• invalidConfigurationReference: De referentie naar het configuratiebestand verschilt van het huidige actieve configuratiebestand.

• conditionalValidationFailed: Validatie op conditionele afspraken (buiten het XSD) is mislukt.

• otherReason: Anderen reden. Vul het element denyReasonExtensionDescription met de reden.

Element denyReasonDescription

Met dit element kan een beschrijving gegeven worden van de reden dat het bericht geweigerd is. Dit element dient altijd gebruikt te worden indien denyReasonExtension otherReason is. Het element denyReasonDescription kan ook gebruikt worden om additionele informatie betreffende de melding mee te leveren, zoals een regelnummer of gedetailleerde foutcode (zoals bijvoorbeeld een CDATA element). Het mag bij alle bovenstaande denyReasons worden gebruikt.

Subelement supplierIdentification

Sublement	Type	Verplicht	Domein	Omschrijving
country	CountryEnum	Ja	nl	land van de verzendende partij volgens ISO 3166-1
nationalIdentifier	String	Ja	Zie noot	Identificatie van de verzendende partij

Subelement subscription

Sublement	Type	Verplicht	Domein	Omschrijving
operatingMode	OperatingModeEnum	Ja	operatingMode0, operatingMode1, operatingMode2, operatingMode3	Bevat de modus van de verbinding
subscriptionStartTime	DateTime	Ja	Datum en tijd als UTC (Zulu notatie)	Dit is het moment dat het registreren succesvol is uitgevoerd en de levering van gegevens gestart is
subscriptionState	SubscriptionStateEnum	Ja	active, suspended	Bevat de status van de verbinding
updateMethod	UpdateMethodEnum	Ja	allElementUpdate, snapshot	Bevat de methode die gebruikt wordt in het huidige bericht
target	Target	Nee	NVT	Het element target wordt gebruikt om het ip-adres respectievelijk het protocol op te nemen die worden gebruikt door de ontvangende partij
filterReference	FilterReference	Nee	NVT	Beschrijving van het filter van toepassing

Toelichting operatingMode

Het element operatingMode geeft aan welk mechanisme gebruikt wordt voor het moment van verzenden. Het domein voor dit element is als volgt:

• operatingMode0: Subscription Management Mechanism
• operatingMode1: Publisher Push on Occurrence
• operatingMode2: Publisher Push Periodic
• operatingMode3: Client Pull

Toelichting updateMethod

Het element updateMethod wordt gebruikt om aan te geven welke methode van bijwerken gebruikt wordt. Is dit element gevuld met de waarde 'snapshot', dan wordt er een compleet beeld verstuurd. Dit betekend dat het complete beeld aan de ontvangende kant word geschoond en gelijk gemaakt met het beeld in de levering.

Wanneer niet de waarde snapshot wordt gebruikt, dienen enkel de situations te worden bijgewerkt die zijn opgenomen in de SituationPublication. Bij de waarde 'allElementUpdate' geldt dat alle opgenomen situationRecords bijgewerkt dienen te worden. Niet opgenomen situationRecords worden als beëindigd beschouwd.

Toelichting target

Het element target wordt gebruikt om het ip-adres respectievelijk het protocol op te nemen die worden gebruikt door de ontvangende partij. Dit element bestaat uit twee elementen: address en protocol.

Toelichting filterReference

Het optionele element filterReference, welke meerdere keren voor mag komen, heeft één verplicht element: keyFilterReference.

Sublement	Type	Verplicht	Domein	Omschrijving
keyFilterReference	String	Ja	NVT	Identificatie van het toegepaste filter