Startseite
Messaging-Webservice Schnittstellenbeschreibung
BackwardSharingEvent
Angaben zu einer Verarbeitungsrückmeldung zu einem zuvor erfolgten forward sharing.
| Name/Typ | min..max | Definition |
|---|---|---|
TransactionUUID |
1..1 |
UUID (Universally Unique ID), die für den Aufruf der backward sharing Operation reserviert wurde und diesen Aufruf eindeutig identifiziert. |
TransactionDateTime |
1..1 |
Zeitstempel, mit dem das EDM Messaging Service die Abarbeitung des backward sharing Aufrufs versehen hat. |
ReferredTransactionUUID |
1..1 |
UUID (Universally Unique ID) des forward sharing Aufrufs, zu dessen Verarbeitung per backward sharing eine Rückmeldung erfolgt. |
ReferredTransactionTypeID |
1..1 |
Art des forward sharing, z.B. initiales Verteilen, Verteilen einer Korrektur oder Stornieren (Codeliste 6413), zu dessen Verarbeitung eine Rückmeldung erfolgt. |
ReferredDocumentUUID |
0..1 |
UUID (Universally Unique ID) der Message aus dem forward sharing Aufruf, zu dessen Verarbeitung per backward sharing eine Rückmeldung erfolgt.Anmerkung: Diese UUID ist genau dann gesetzt, wenn es sich beim forward sharing, auf das Bezug genommen wird, NICHT um eine Stornierung handelt (siehe ReferredTransactionTypeID-Element). |
InterfaceVersionID |
1..1 |
Konstante, die vom Konnektor, über den der Aufruf der backward sharing Operation erfolgt ist, angegeben wurde, und die anzeigt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
SharedByConnectorID |
1..1 |
ID des Konnektors, über den der Aufruf der backward sharing Operation erfolgt ist. Anmerkung 1: Die ID des Konnektors wurde vom EDM Messaging Service erfolgreich überprüft (authentifiziert), andernfalls wäre der backward sharing Aufruf zurückgewiesen worden.Anmerkung 2: Weitere Erläuterungen zu Konnektor-IDs finden sich in der Schnittstellenbeschreibung. |
SharedByConnectorVersionID |
1..1 |
Version des Konnektors, über den der Aufruf der backward sharing Operation erfolgt ist.Anmerkung: Es wird die vom Konnektor gelieferte Versions-Angabe weitergegeben. Eine Überprüfung durch das EDM Messaging Service ist nicht vorgesehen bzw. möglich. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
SharedByPartyID |
0..* |
Die in den EDM Stammdaten zugewiesenen GLNs (Global Location Number)s für jene Beteiligten, die als „Absender“ des backward sharing fungieren. Anmerkung 1: Es können ausschließlich solche Beteiligte als Absender einer backward sharing Operation auftreten, die als Empfänger in der forward sharing Operation, auf welche sich das backward sharing bezieht, genannt sind. Anmerkung 2: Gegenwärtig können über das backward sharing zwei Arten von Information ausgetauscht werden. 1. Der Status der technischen Verarbeitung einer Message hinsichtlich der Übernahme in eine Ziel-DB („Validierung und Speicherung“). 2. Die Inhaltliche Bestätigung der forward sharing Operation einer Übergabe/Übernahme-Message durch einen Benutzer. Diese Form der Bestätigung soll von einem Konnektor dazu verwendet werden Aufträge inhaltlich zu bestätigen um die nächsten Prozessschritte einzuleiten. Beim Aufruf der ShareRetrieverStatus-Operation werden bei der technischen Verarbeitung einer Message keine Beteiligten identifiziert. Eine Zuordnung zu Beteiligten, die als Absender der Verarbeitungsrückmeldung gelten, wird hingegen vom EDM Messaging Service hergestellt. Das SharedByPartyID-Element der BackwardSharingEvent-Struktur enthält genau diese vom EDM Messaging Service hergestellte Zuordnung von Beteiligten. |
SharedToPartyID |
1..1 |
Der Empfänger des backward sharing (des Verteilens einer Verarbeitungsrückmeldung).Anmerkung: Der Empfänger eines backward sharing muss mit dem Absender des forward sharing übereinstimmen, auf welches sich das backward sharing bezieht. |
OperationTypeID |
1..1 |
Die auf Seite des forward sharing Empfängers durchgeführte Operation bzw. Aktivität, auf die sich die per backward sharing verteilte Rückmeldung bezieht (Codeliste 6801).Anmerkung: An dieser Stelle können gegenwärtig die Werte „Validierung und Speicherung“ (Übernahme in die Ziel-DB) und „Durchsicht und Prüfung durch Benutzer“ (Bestätigungsmessage) angegeben werden. |
OperationStatusID |
1..1 |
Der Status der in OperationTypeID angegebenen Verarbeitungsoperation, z.B. Erfolg, Erfolg mit Hinweisen, oder Fehler (Codeliste 2089). |
StatusReasonID |
0..1 |
Einer aus einer vordefinierten Liste von Gründen für den Status der Verarbeitungsoperation bzw. Bearbeitungsaktivität (Codeliste 6838). Anmerkung 1: Die Auswahl eines Grunds ist im Allgemeinen nur im Fehlerfall angegeben (OperationStatusID zeigt an, dass ein Fehler vorliegt).Anmerkung 2: Wenn der Grund für den Status ein anderer ist, als einer, der in Codeliste 6838 definiert ist, dann entfällt die StatusReasonID-Angabe. In diesem Fall soll StatusDecription angegeben sein, und Angaben zum Grund für den Status bzw. Fehler beinhalten. |
StatusDescription |
0..1 |
Textuelle Beschreibung des Status der Verarbeitungsoperation bzw. Bearbeitungsaktivität (Sprache: Codeliste 7632. Ausschließlich Deutsch). |
AuthenticatedCancellation
Angaben zur Stornierung einer Message, ggf. mit elektronischen Siegeln oder Signaturen versehen.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentUQ |
1..1 |
Die Angaben zur Stornierung.Anmerkung: „UQ“ steht für Unique. Diese Elementbezeichnung wird gewählt, um die Eindeutigkeit des Elementnamens über alle Namensräume hinweg zu gewährleisten, und so gewisse Attacken in Zusammenhang mit Siegeln und Signaturen zu unterbinden. |
ds:Signatureds:Signature |
0..* |
Elektronische Siegel und/oder Signaturen zur Stornierung, in dem auf dem XMLDSIG-Format basierenden XAdES-Format.Anmerkung: Das Anbringen von Siegeln und/oder Signaturen ist optional. |
AuthenticatedDocument
Angaben zu einer Message, bestehend aus Inhalten, Metadaten (z.B. zum Erstellungsdatum) und ggf. elektronischen Siegeln oder Signaturen.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentUQ |
1..1 |
Die Message, die initial oder zur Korrektur verteilt wird, zusammen mit Metadaten und allfälligen Anhängen.Anmerkung: „UQ“ steht für Unique. Diese Elementbezeichnung wird gewählt, um die Eindeutigkeit des Elementnamens über alle Namensräume hinweg zu gewährleisten, und so gewisse Attacken in Zusammenhang mit Siegeln und Signaturen zu unterbinden. |
ds:Signatureds:Signature |
0..1 |
Elektronisches Siegel und/oder Signatur zur Message, in dem auf dem XMLDSIG-Format basierenden XAdES-Format. Anmerkung 1: Das Anbringen von einem Siegel und/oder Signatur ist optional.Anmerkung 2: Besitzt die Message selbst ein standardisiertes Format, das bereits Siegel und/oder Signaturen vorsieht, dann sind vorrangig die gemäß diesem Format vorgesehenen Siegel und/oder Signaturen bereitzustellen. |
Cancellation
Angaben zur Stornierung einer Message bzw einer „Kette von Messages“, die durch Überarbeitungen auseinander hervorgingen.
| Name/Typ | min..max | Definition |
|---|---|---|
VersionBracketUUID |
1..1 |
Die UUID der zu stornierenden „Kette von Messages“. |
ChangeReasonID |
1..1 |
Auswahl des Grunds für das Widderrufen einer zuvor erfolgten Übermittlung (Codeliste 7521). |
Description |
0..1 |
Beschreibung bzw. Begründung des Widerrufens (Sprache: Codeliste 7632. Ausschließlich Deutsch zulässig). Anmerkung 1: Die Beschreibung bzw. Begründung des Widerrufens erfolgt ergänzend zur Auswahl des Widerrufungsgrunds in ChangeReasonID.Anmerkung 2: Im Gegensatz zur Auswahl des Widerrufungsgrunds in ChangeReasonID ist nicht für alle Widerrufungen zwingend eine Beschreibung bzw. Begründung in Description erforderlich. |
DocumentOriginPartyID |
0..1 |
Die GLN (Global Location Number), die dem Message- und Stornierungs-Ersteller-Beteiligten in den EDM Stammdaten zugeordnet ist.Anmerkung: In Zukunft wird dieses Feld verpflichtend sein. |
ContextIDReference
Verweis auf ein in Beziehung stehendes Objekt, mit einer ID die keine UUID ist, und mit einer Beschreibung der Art der Beziehung.
| Name/Typ | min..max | Definition |
|---|---|---|
ContextID |
1..1 |
ID, welche den jeweilige Kontext, zu dem eine Message in Beziehung steht, identifiziert, z.B. VEBSV-ID. |
ContextTypeID |
1..1 |
Art des Kontexts, z.B. VEBSV-ID (Codeliste 7688). |
ContextUUIDReference
Verweis auf ein in Beziehung stehendes Objekt, mit einer ID, welche eine UUID ist (Universally Unique ID), und mit einer Beschreibung der Art der Beziehung.
| Name/Typ | min..max | Definition |
|---|---|---|
ContextUUID |
1..1 |
UUID, welche die jeweilige Kontext-Instanz, zu dem eine Message in Beiehung steht, z.B. Vertrag oder Auftrag, eindeutig identifiziert. |
ContextTypeID |
1..1 |
Art des Kontexts, z.B. Auftrag (Codeliste 7263). |
Document
Message, bestehend aus Kopfdaten (z.B. Erstellungsdatum), Inhalt und allfälligen Anhängen (angehängten Bytefolgen bzw. Dateien).
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentHeader |
1..1 |
„Kopfdaten“, d.h. allgemeine Angaben zur übermittelten Message, z.B. UUID und Typ der Message. |
DocumentContent |
1..1 |
Eine Message von dem im DocumentHeader (DocumentTypeID-Element) angegebenen Message-Typ.Anmerkung: Zur besseren Trennung von Message-Formaten und dem EDM Messaging Service sind die Message-Formate nicht in die XML Schema Definitionen für die Inputs und Outputs der EDM Messaging Service Operationen eingebunden. Stattdessen wird das any-Element verwendet, und vom EDM Messaging Service auf Basis einer Message-Typ Codeliste das richtige Message-Format zur Message-Validierung herangezogen. |
AttachmentBinaryObject |
0..8 |
Message-Anhang. Anhänge sind base64-codiert (siehe https://www.w3.org/TR/xmlschema-2/#base64Binary). Anmerkung 1: Pro Message sind gegenwärtig nicht mehr als 8 Anhänge zulässig. Diese Vorgabe ist bereits durch die XML Schema Definition (XSD) für die Request-Daten abgebildet. Anmerkung 2: Ein einzelner Anhang darf – in base64-Codierung – nicht größer als 16 MiB sein, d.h. 16*1024² Bytes. Diese Vorgabe ist bereits durch die XML Schema Definition (XSD) für die Request-Daten abgebildet.Anmerkung 3: Alle Anhänge zusammen dürfen – in base64-Codierung – nicht größer als 64 MiB, d.h. 64*1024² sein. Diese Vorgabe ist nicht durch die XML Schema Definition (XSD) für die Request-Daten abgebildet bzw. abbildbar, und wird durch das EDM Messaging Service somit separat geprüft. |
DocumentContent
Message-Inhalt.Anmerkung: (XML-)Formatvorgaben für Message-Inhalte werden von den Formatvorgaben für EDM Messaging Service Inputs und Outputs getrennt verwaltet.
| Name/Typ | min..max | Definition |
|---|
DocumentHeader
Kopfdaten (Metadaten) zu einer Message, z.B. Art der Message und Ersteller.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentTypeID |
1..1 |
Art der Message (Codeliste 2551). |
DocumentUUID |
1..1 |
UUID, welche die Message eindeutig identifiziert. |
VersionBracketUUID |
1..1 |
UUID, welche eine Kette von Messages, die durch Überarbeitungen bzw. Korrekturen auseinander hervorgegangen sind, eindeutig identifiziert. |
VersionSequenceNumber |
1..1 |
Nichtnegative Ganzzahl, die eine Reihenfolge von Messages in einer Kette von Überarbeitungen bzw. Korrekturen definiert. |
DocumentDisplayID |
0..1 |
Eine ID, die etwa in Benutzeroberflächen oder PDF-Exporten als Dokument-ID aufscheinen soll, z.B Lieferschein-Nummer.Anmerkung: Im Gegensatz zur DocumentUUID bestehen für die DocumentDisplayID keine „universellen“ Eindeutigkeitsanforderungen. |
DocumentDesignation |
0..1 |
Titel des Dokuments bzw. der Message, z.B. „Lieferschein Probst“. Anmerkung 1: Die DocumentDisplayID hat im DocumentDesignation-Text nicht mit enthalten zu sein.Anmerkung 2: In Fällen, in welchen in Benutzeroberflächen auf das Dokument Bezug genommen werden soll, aber keine DocumentDesignation angegeben ist (z.B. in tabellarischen Message-Darstellungen), wird empfohlen, anstelle der DocumentDesignation die Bezeichnung des Message-Typs anzugeben (über DocumentTypeID aus der betreffenden Codeliste). |
ChangeReasonID |
0..1 |
Auswahl des Grunds für die Korrektur bei Verwendung der Operation für die Korrektur einer zuvor erfolgten Übermittlung (Codeliste 7521). Anmerkung 1: ChangeReasonID ist genau dann angegeben, wenn es sich bei der Message (aus Sicht des Message-Erstellers) um die Korrektur einer zuvor erstellten Message handelt. |
Description |
0..1 |
Beschreibung bzw. Begründung einer Korrektur (Sprache: Codeliste 7632. Ausschließlich Deutsch zulässig). Anmerkung 1: Handelt es sich bei der Message NICHT um eine Korrektur, DARF das Element Description nicht angegeben sein. Anmerkung 2: Die Beschreibung bzw. Begründung der Korrektur erfolgt ergänzend zur Auswahl des Korrekturgrunds in ChangeReasonID.Anmerkung 3: Im Gegensatz zur Auswahl des Korrekturgrunds in ChangeReasonID ist nicht für alle Korrekturen zwingend eine Beschreibung bzw. Begründung einer Korrektur in Description erforderlich. |
ContextUUIDReference |
1..1 |
Kontextreferenzen für die Message. Mit solchen Referenzen kann ein Beteiligter, der mehrere Messages erstellt bzw. übermittelt, Zusammengehörigkeiten ausdrücken, z.B. welche Messages zum selben Auftrag bzw. Vertrag gehören. |
ContextIDReference |
0..64 |
Kontextreferenzen, die mit anderen IDs als UUIDs hergestellt werden, z.B. mittels VEBSV-IDs. |
DocumentOriginPartyID |
1..1 |
Die GLN (Global Location Number), die dem Message-Ersteller-Beteiligten in den EDM Stammdaten zugeordnet ist. |
ReferencedDocumentUUID |
0..1 |
Die DocumentUUID, zu welcher man einen Korrekturvorschlag einbringen möchte. Anmerkung 1: Die referenzierte DocumentUUID darf selbst kein Korrekturvorschlag sein.Anmerkung 2: Die referenzierte DocumentUUID muss zum Zeitpunkt des Versendens die aktuellste DocumentUUID innerhalb der VersionBracket-Kette sein. |
ObjectUUID |
0..1 |
Die UUID, welche das Objekt in MasterMessageData eindeutig identifiziert. Ab Interface-Version 1.09 verpflichtend. |
ForwardSharingEvent
Angaben zu einem forward sharing.Anmerkung: Bei einem forward sharing handelt es sich um das Übermitteln einer Message, einer Message-Korrektur, einem Message-Korrekturvorschlag oder einer Message-Stornierung.
| Name/Typ | min..max | Definition |
|---|---|---|
TransactionUUID |
1..1 |
UUID (Universally Unique ID), die für den Aufruf der forward sharing Operation reserviert wurde und diesen Aufruf eindeutig identifiziert. |
TransactionDateTime |
1..1 |
Zeitstempel, mit dem das EDM Messaging Service die Abarbeitung des forward sharing Aufrufs versehen hat. |
TransactionTypeID |
1..1 |
Art des forward sharing, z.B. initiales Verteilen, Verteilen einer Korrektur oder Stornieren (Codeliste 6413). |
InterfaceVersionID |
1..1 |
Konstante, die vom Konnektor, über den der Aufruf der forward sharing Operation erfolgt ist, angegeben wurde, und die anzeigt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
SharedByConnectorID |
1..1 |
ID des Konnektors, über den der Aufruf der forward sharing Operation erfolgt ist.Anmerkung: Die ID des Konnektors wurde vom EDM Messaging Service erfolgreich überprüft (authentifiziert), andernfalls wäre der forward sharing Aufruf zurückgewiesen worden. |
SharedByConnectorVersionID |
1..1 |
Version des Konnektors, über den der Aufruf der forward sharing Operation erfolgt ist.Anmerkung: Es wird die vom Konnektor gelieferte Versions-Angabe weitergegeben. Eine Überprüfung durch das EDM Messaging Service ist nicht vorgesehen bzw. möglich. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
SharedByPartyID |
1..1 |
Die GLN (Global Location Number), die dem „Absender“-Beteiligten der Message, der Message-Korrektur oder der Message-Stornierung, in den EDM Stammdaten zugeordnet ist. |
SharedToParty |
1..* |
Der oder die Empfänger des forward sharing (des Verteilens einer Message, des Verteilens einer Message-Korrektur, oder des Verteilens einer Stornierung).Anmerkung: Das EDM Messaging Service liefert nur jene Empfänger, auf die der abfragende Empfänger Zugriff hat, d.h. nicht notwendigerweise die komplette beim Versenden angebene Empfänger-Liste. Dies ist in der Schnittstellenbeschreibung im Abschnitt „Zugriffsrechte“ erläutert. |
ConstraintComplianceIndicator |
0..1 |
Sofern für den geteilten Message-Typ Prüfregeln definiert sind, und durch das EDM Messaging Service geprüft wurden, ist dieser Ja/Nein-Wert angegeben, der ausdrückt, ob alle Prüfregeln eingehalten sind.Anmerkung: Ein Nein-Wert an dieser Stelle bedeutet, dass sogenannte Hinweis-Prüfregeln nicht eingehalten sind. Wären Ablehnungs-Prüfregeln nicht eingehalten worden, dann wäre das forward sharing nicht erfolgreich vom EDM Messaging Service entgegengenommen worden, sondern allenfalls per SOAP-Fault (synchron) oder per ProcessingEvent (asynchron) abgehandelt. |
DocumentContentAvailabilityIndicator |
0..1 |
Ja/Nein-Wert, der angibt, ob die per forward sharing geteilten Inhalte noch vom EDM Messaging Service (insbesondere per RetrieveDocument-Operation) abrufbar sind (true = noch abrufbar). Anmerkung 1: Die Aufbewahrung von geteilten Inhalten am EDM Messaging Service wird nur für begrenzte Zeiträume garantiert. Metadaten zu geteilten Inhalten werden hingegen unbegrenzt durch das EDM Messaging Service aufbewahrt. Es kann deshalb der Fall eintreten, dass am EDM Messaging Service nur noch Metadaten zu geteilten Inhalten verfügbar sind, nicht aber die Inhalte selbst.Anmerkung 2: Der DocumentContentAvailablityIndicator ist genau dann angegeben, wenn es sich bei der Art des forward sharings (siehe TransactionTypeID-Element) NICHT um Stornieren handelt. |
AuthenticatedCancellation |
0..1 |
Angaben zur Stornierung einer Message.Anmerkung 1: AuthenticatedCancellation ist genau dann angegeben, wenn es sich bei der forward transaction um eine „Stornierung“ handelt (siehe auch TransactionTypeID). |
DocumentHeader |
0..1 |
„Kopfdaten“, d.h. allgemeine Angaben zur übermittelten Message, z.B. UUID und Typ der Message.Anmerkung: Solche „Kopfdaten“ sind genau dann angegeben, wenn es sich bei der forward transaction um ein initiales Übermitteln oder ein Korrigieren handelt, nicht jedoch beim Stornieren. |
ForwardSharingEventRetrieved
Angaben zu einem forward sharing.Anmerkung: Bei einem forward sharing handelt es sich um das Übermitteln einer Message, einer Message-Korrektur, einem Message-Korrekturvorschlag oder einer Message-Stornierung.
| Name/Typ | min..max | Definition |
|---|---|---|
TransactionUUID |
1..1 |
UUID (Universally Unique ID), die für den Aufruf der forward sharing Operation reserviert wurde und diesen Aufruf eindeutig identifiziert. |
TransactionDateTime |
1..1 |
Zeitstempel, mit dem das EDM Messaging Service die Abarbeitung des forward sharing Aufrufs versehen hat. |
TransactionTypeID |
1..1 |
Art des forward sharing, z.B. initiales Verteilen, Verteilen einer Korrektur oder Stornieren (Codeliste 6413). |
InterfaceVersionID |
1..1 |
Konstante, die vom Konnektor, über den der Aufruf der forward sharing Operation erfolgt ist, angegeben wurde, und die anzeigt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
SharedByConnectorID |
1..1 |
ID des Konnektors, über den der Aufruf der forward sharing Operation erfolgt ist.Anmerkung: Die ID des Konnektors wurde vom EDM Messaging Service erfolgreich überprüft (authentifiziert), andernfalls wäre der forward sharing Aufruf zurückgewiesen worden. |
SharedByConnectorVersionID |
1..1 |
Version des Konnektors, über den der Aufruf der forward sharing Operation erfolgt ist.Anmerkung: Es wird die vom Konnektor gelieferte Versions-Angabe weitergegeben. Eine Überprüfung durch das EDM Messaging Service ist nicht vorgesehen bzw. möglich. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
SharedByPartyID |
1..1 |
Die GLN (Global Location Number), die dem „Absender“-Beteiligten der Message, der Message-Korrektur oder der Message-Stornierung, in den EDM Stammdaten zugeordnet ist. |
SharedToParty |
1..* |
Der oder die Empfänger des forward sharing (des Verteilens einer Message, des Verteilens einer Message-Korrektur, oder des Verteilens einer Stornierung).Anmerkung: Das EDM Messaging Service liefert nur jene Empfänger, auf die der abfragende Empfänger Zugriff hat, d.h. nicht notwendigerweise die komplette beim Versenden angebene Empfänger-Liste. Dies ist in der Schnittstellenbeschreibung im Abschnitt „Zugriffsrechte“ erläutert. |
ConstraintComplianceIndicator |
0..1 |
Sofern für den geteilten Message-Typ Prüfregeln definiert sind, und durch das EDM Messaging Service geprüft wurden, ist dieser Ja/Nein-Wert angegeben, der ausdrückt, ob alle Prüfregeln eingehalten sind.Anmerkung: Ein Nein-Wert an dieser Stelle bedeutet, dass sogenannte Hinweis-Prüfregeln nicht eingehalten sind. Wären Ablehnungs-Prüfregeln nicht eingehalten worden, dann wäre das forward sharing nicht erfolgreich vom EDM Messaging Service entgegengenommen worden, sondern allenfalls per SOAP-Fault (synchron) oder per ProcessingEvent (asynchron) abgehandelt. |
ObjectStatus
Angaben dazu, ob automatische Prüfungen eines Begleitscheins Hinweise ergeben bzw. welche Art von Hinweisen sich ergeben.
| Name/Typ | min..max | Definition |
|---|---|---|
StatusTypeID |
1..1 |
Hinweis-Kriterium (Codeliste 9813). |
StatusID |
1..1 |
Art der Hinweise, die es in Bezug auf das unter StatusTypeID angegebene Kriterium gibt (Codeliste 2089). |
PostProcessingEvent
Angaben zum Status von Aktionen bzw. Interaktionen, die das EDM Messaging Service in Folge des erfolgreichen Aufrufs einer schreibenden Operation mit externen Systemen durchführt.Anmerkung: Diese Struktur wird bislang ausschließlich für Rückmeldungen zum Status von SMS-Benachrichtigungen und beim erfolgreichen Erstellen eines Transportdokuments verwendet.
| Name/Typ | min..max | Definition |
|---|---|---|
TransactionUUID |
1..1 |
UUID (Universally Unique ID), die dieses Event eindeutig identifiziert. |
DateTime |
1..1 |
Zeitpunkt, zu dem das EDM Messaging Service die Information zum (neuen) Status der Interaktion mit einem externen System erhalten hat. |
ReferredTransactionUUID |
1..1 |
UUID (Universally Unique ID), die für den Aufruf der forward sharing oder backward sharing Operation reserviert wurde und diesen Aufruf eindeutig identifiziert. |
ReferredTransactionTypeID |
1..1 |
Art der schreibenden Operation, zu deren Verarbeitung eine Rückmeldung erfolgt (Codeliste 6413).Anmerkung: Zu Verarbeitungsrückmeldungen (ShareRetrieverStatus) sind keine nachfolgenden Interaktionen mit externen Systemen möglich, und somit auch keine "PostProcessingEvents". |
OperationTypeID |
1..1 |
Die vom EDM Messaging Service mit einem externen System durchgeführte Interaktion, auf die sich die Verarbeitungsrückmeldung bezieht (Codeliste 1313).Anmerkung: Bislang sind nur zu einer einzigen Art von Interaktion Statusbenachrichtigungen möglich, namentlich zu SMS-Benachrichtigungen (GTIN 9008390119037). |
TelephoneCommunicationNetworkEndpointID |
0..1 |
Telefonnummer, auf die sich die Status-Rückmeldung bezieht. Anmerkung 1: Dieses Element ist nur dann in PostProcessingEvent-Instanzen angegeben, wenn sich diese auf SMS-Benachrichtigungen beziehen (OperationTypeID gleich 9008390119037).Anmerkung 2: Wenn dieses Element in PostProcessingEvent-Instanzen zu SMS-Benachrichtigungen fehlt, dann bedeutet das, dass sich die Statusinformation auf sämtliche zu benachrichtigenden Telefonnummern aus dem ursprünglichen Request bezieht. |
OperationStatusID |
0..1 |
Status der in OperationTypeID angegebenen Operation bzw. Interaktion (Codeliste 2089).Anmerkung: Der Status von Interaktionen mit externen Systemen kann nicht notwendigerweise in allen Fällen automatisch einer der 3 Kategorien „Erfolg“, „Erfolg, mit Hinweisen“, „Fehler“ zugeordnet werden. Daher ist in PostProcessingEvent-Instanzen nicht notwendigerweise ein OperationStatusID-Element enthalten. |
ForwardedOperationStatusID |
0..1 |
Statuscode, wie er vom externen System, mit das EDM Messaging Service interagiert hat, geliefert wurde.Anmerkung: Für Status-Informationen zu SMS-Benachrichtigungen wird hier der vom SMS-Dienst gelieferte Status wiedergegeben. |
StatusDescription |
0..1 |
Textuelle Beschreibung des Status der vom EDM Messaging Service mit einem externen System durchgeführten Interaktion (Sprache: Codeliste 7632).Anmerkung: Im allgemeinen wird an dieser Stelle die vom externen System gelieferte Statusmeldung weitergegeben, allfällig ergänzt um Informationen vom EDM Messaging Service. |
ResultLink |
0..1 |
Liefert den Link zum Transportdokument. Dieser Link hat eine Gültigkeit von 14 Tagen. Ist befüllt wenn es sich um das Ergebnis der Erstellung eines Transportdokuments handelt. |
ResultLinkValidityEnd |
0..1 |
Zeigt an, wie lange der Link zum Transportdokument gültig ist. |
ProcessingEvent
Angaben zur Verarbeitung des Aufrufs einer schreibenden Operation durch das EDM Messaging Service.
| Name/Typ | min..max | Definition |
|---|---|---|
TransactionUUID |
1..1 |
UUID (Universally Unique ID), die für den Aufruf der forward sharing oder backward sharing Operation reserviert wurde und diesen Aufruf eindeutig identifiziert. |
ProcessingCompletionDateTime |
1..1 |
Zeitstempel, mit dem das EDM Messaging Service die Abarbeitung des Aufrufs der schreibenden asynchronen Operation versehen hat. |
ReferredTransactionTypeID |
1..1 |
Art der schreibenden Operation, zu deren Verarbeitung eine Rückmeldung erfolgt (Codeliste 6413). |
OperationTypeID |
1..1 |
Die vom EDM Messaging Service durchgeführte Operation, auf die sich die Verarbeitungsrückmeldung bezieht (Codeliste 6801).Anmerkung: An dieser Stelle ist ausschließlich die „Validierung und Speicherung“ vorgesehen. |
OperationStatusID |
1..1 |
Status der in OperationTypeID angegebenen Verarbeitungsoperation (Codeliste 2089).Anmerkung: Da im Erfolgsfall kein ProcessingEvent-Update generiert wird, sondern ein forward sharing oder backward sharing Update, steht dieser Eintrag gegenwärtig immer auf „Fehler“. |
StatusReasonID |
0..1 |
Einer aus einer vordefinierten Liste von Gründen für den Status der Verarbeitungsoperation (Codeliste 1701).Anmerkung: Wenn der Grund für den Status ein anderer ist, als einer, der in Codeliste 1701 definiert ist, dann entfällt die StatusReasonID-Angabe. In diesem Fall ist nur StatusDecription angegeben, mit Angaben zum Grund für den Status bzw. Fehler beinhalten. |
StatusDescription |
0..1 |
Textuelle Beschreibung des Status der Verarbeitung durch das EDM Messaging Service (Sprache: Codeliste 7632. Ausschließlich Deutsch). |
Recipient
Angaben zum Empfänger einer Message-Übermittlung (bzw. einer Korrektur- oder Stornierungs-Übermittlung).
| Name/Typ | min..max | Definition |
|---|---|---|
RecipientID |
1..1 |
Die GLN (Global Location Number), welche dem Empfänger bzw. Adressat der Message, der Message-Korrektur oder der Message-Stornierung, in den EDM Stammdaten zugeordnet ist. |
TransactionPurposeCategoryID |
1..1 |
Klassifizierung des beabsichtigten Zwecks des forward sharings an diesen Empfänger, z.B. zur Info oder zur Bearbeitung (Codeliste 2976). |
NoteText |
0..1 |
Eine allfällige Anmerkung bzw. „Begleitnotiz“ vom Absender der Message, der Message-Korrektur oder der Stornierung an den Empfänger bzw. Adressaten. |
TelephoneCommunicationNetworkEndpointID |
0..8 |
Telefonnummern für SMS-Übermittlungen an Empfänger. Anmerkung 1: Mit einzelnen Message-Arten, insbesondere mit der Übergabe/Übernahme-Message, kann durch Angabe einer oder mehrerer Telefonnummern für SMS-Übermittlungen ausgelöst werden, dass das EDM Messaging Service per SMS Empfänger über das Eintreffen einer Message benachrichtigt bzw. per entsprechender URL dem SMS-Empfänger eine Einsichtnahme in die Message sowie allfällige weitere Aktionen ermöglicht.Anmerkung 2: Um gut für die automatische Nutzung geeignet zu sein, definiert das Schema "strenge" Vorgaben in Bezug auf das Muster, dem angegebene Telefonnummern zu entsprechen haben. Insbesondere hat die Nummer, abgesehen von einem möglichen führenden "+", ausschließlich aus Ziffern zu bestehen, d.h. keinerlei Trennzeichen zu enthalten. |
PublicKeyObject
Informationen zu einem Public Key
| Name/Typ | min..max | Definition |
|---|---|---|
Format |
1..1 |
Das verwendete Format, womit die Variablen des öffentlichen Schlüssels kodiert wurden. Aktuell beträgt dieser Wert immer "X.509". |
Algorithm |
1..1 |
Beschreibt die Art des Schlüssels. Aktuell handelt es sich immer um RSA-Schlüssel. |
Encoded |
1..1 |
Die kodierten Daten des Schlüssels (in Base64-Form). |
UpdateEvent
Angaben zu einem EDM Messaging Service Update (ForwardSharing, BackwardSharing, Processing, PostProcessing oder LaunchDocumentAction).
| Name/Typ | min..max | Definition |
|---|---|---|
ForwardSharingEvent |
0..1 |
Angaben zu einem forward sharing. |
BackwardSharingEvent |
0..1 |
Angaben zu einem backward sharing. |
ProcessingEvent |
0..1 |
Angaben zur Verarbeitung des Aufrufs einer asynchronen schreibenden Operation durch das EDM Messaging Service. ProcessingEvents sind nur für den Aufrufenden der schreibenden Operation, auf die sich die Angaben beziehen, abrufbar bzw. „sichtbar“.Anmerkung: Ein ProcessingEvent-Update wird nur generiert, wenn eine forward sharing oder eine backward sharing Operation nicht erfolgreich abgearbeitet werden kann. Die erfolgreiche Abarbeitung ist hingegen über entsprechende ForwardSharingEvents oder BackwardSharingEvents ersichtlich. |
PostProcessingEvent |
0..1 |
Angaben zum Status von Aktionen bzw. Interaktionen, die das EDM Messaging Service in Folge des erfolgreichen Aufrufs einer schreibenden Operation mit externen Systemen durchführt. Anmerkung 1: Diese Struktur wird aktuell für 2 Aktionen verwendet: 1. für die Rückmeldungen zum Status von SMS-Benachrichtigungen und 2. Zur Rückmeldung über die Erstellung eines Transportdokuments. Anmerkung 2: PostProcessingEvents kann es nur zu erfolgreichen Aufrufen asynchroner schreibender Operationen geben, d.h. "in Kombination" mit einem ForwardSharingEvent oder BackwardSharingEvent zur selben Transaktion.Anmerkung 3: Wenn beim forward sharing Telefonnummern für SMS-Benachrichtigungen angegeben werden, dann sind unterschiedlichste Fälle in Bezug auf Statusrückmeldungen möglich und zulässig. So ist etwa möglich, dass es zu keinerlei Statusrückmeldung kommt. Es ist aber ebenso möglich, dass es für eine Telefonnummer zu mehreren Statusrückmeldungen (Status-Updates) kommt. Auch bezüglich der Zusammenfassung - wird der Status je Telefonnummer rückgemeldet oder für alle Telefonnummern auf einmal - sind alle Varianten möglich und zulässig. Welche dieser Varianten eintreten, hängt vom SMS-Service ab, das vom EDM Messaging Service genutzt wird. Das EDM Messaging Service gibt solche Statusrückmeldungen eines SMS-Service in PostProcessingEvent-Strukturen weiter. |
UpdateSignalEvent |
0..1 |
Benachrichtigung dazu, dass es Änderungen an einem vollelektronischen Begleitschein gibt. Anmerkung 1: Die Datenstruktur ist für aus IT-Systemen automatisch generierte Benachrichtigungen zu Updates vorgesehen, und wird bislang ausschließlich für Benachrichtigungen zu Änderungen an einem vollelektronischen Begleitschein genutzt.Anmerkung 2: Das VEBSV Webservice dient zur Übermittlung von Angaben in das Behördensystem. Es ist nicht darauf ausgelegt, Informationen in Unternehmens-Systemen auf einem aktuellen Stand (des Behördensystems) zu halten, und sieht aus diesem Grund auch kein Polling vor. Im Gegensatz dazu ist das EDM Messaging Service auf Polling ausgelegt. Über das EDM Messaging Service empfangene Signale (Benachrichtigungen) zu Begleitschein-Änderungen können somit für Unternehmens-Softwarelösungen als Auslöser herangezogen werden, über das VEBSV Webservice aktuelle Begleitschein-Daten abzurufen. |
LaunchDocumentActionEvent |
0..1 |
Angaben zu einem LaunchDocumentAction. |
UpdateSignal
Angaben zum Update eines Begleitscheins.Anmerkung: Diese Angaben stammen aus der EDM VEBSV Anwendung, welche diese Angaben zur Verteilung an das EDM Messaging Service weitergibt.
| Name/Typ | min..max | Definition |
|---|---|---|
UpdateDateTime |
1..1 |
Zeitstempel des Begleitschein-Updates (von der VEBSV Anwendung stammende Angabe). |
TransportID |
0..1 |
Beschreibung zur einzigartigen Erkennung eines Transports durch die Transport-ID |
AffectedObjectID |
0..1 |
VEBSV-ID des vollelektronischen Begleitscheins, der sich geändert hat. |
ObjectStatus |
0..8 |
Angaben zur Art der Hinweise, die es zum betreffenden Begleitschein gibt. |
TriggerPartyID |
0..1 |
Die Personen-GLN (Global Location Number), die dem „Auslöser“ des Begleitschein-Updates in den EDM Stammdaten zugeordnet ist.Anmerkung: Das EDM Messaging Service liefert den auslösenden Beteiligten genau dann, wenn der abfragende Konnektor auf für diesen Beteiligten bestimmte Inhalte Zugriff hat. Damit ist „eigenes“ von „fremdem“ Auslösen unterscheidbar. Siehe auch Abschnitt „Zugriffsrechte“ in der Schnittstellenbeschreibung. |
TriggerEventCategoryID |
0..1 |
Art der Begleitschein-Interaktion - Meldungsübermittlung, Meldungskorrektur oder Meldungsstornierung - welche die Begleitschein-Änderung ausgelöst hat (Codeliste 6413). |
TriggerEventTypeID |
0..1 |
Die VEBSV-Meldungsart, welche das Update ausgelöst hat (Codeliste 9850). |
SharedToPartyID |
1..* |
Der oder die Beteiligten, für welche die Informationen zum Update eines Begleitscheins bestimmt sind.Anmerkung: Das EDM Messaging Service liefert nur jene Beteiligten, auf die der abfragende Konnektor Zugriff hat, d.h. nicht notwendigerweise die komplette Liste von Beteiligten, für welche die Informationen bestimmt sind. Dies ist in der Schnittstellenbeschreibung im Abschnitt „Zugriffsrechte“ erläutert. |
UpdateSignalEvent
Angaben zum Update eines Begleitscheins.Anmerkung: Alle Angaben bis auf die TransactionUUID stammen aus der EDM VEBSV Anwendung, welche diese Angaben zur Verteilung an das EDM Messaging Service weitergibt.
| Name/Typ | min..max | Definition |
|---|---|---|
TransactionUUID |
1..1 |
UUID (Universally Unique ID), mit der im EDM Messaging Service die Benachrichtigung zu Änderungen am vollelektronischen Begleitschein eindeutig identifiziert wird. |
TransportID |
0..1 |
Beschreibung zur einzigartigen Erkennung eines Transports durch die Transport-ID |
UpdateDateTime |
1..1 |
Zeitstempel des Begleitschein-Updates (von der VEBSV Anwendung stammende Angabe). |
AffectedObjectID |
0..1 |
VEBSV-ID des vollelektronischen Begleitscheins, der sich geändert hat. |
ObjectStatus |
0..8 |
Angaben zur Art der Hinweise, die es zum betreffenden Begleitschein gibt. |
TriggerPartyID |
0..1 |
Die Personen-GLN (Global Location Number), die dem „Auslöser“ des Begleitschein-Updates in den EDM Stammdaten zugeordnet ist.Anmerkung: Das EDM Messaging Service liefert den auslösenden Beteiligten genau dann, wenn der abfragende Konnektor auf für diesen Beteiligten bestimmte Inhalte Zugriff hat. Damit ist „eigenes“ von „fremdem“ Auslösen unterscheidbar. Siehe auch Abschnitt „Zugriffsrechte“ in der Schnittstellenbeschreibung. |
TriggerEventCategoryID |
0..1 |
Art der Begleitschein-Interaktion - Meldungsübermittlung, Meldungskorrektur oder Meldungsstornierung - welche die Begleitschein-Änderung ausgelöst hat (Codeliste 6413). |
TriggerEventTypeID |
0..1 |
Die VEBSV-Meldungsart, welche das Update ausgelöst hat (Codeliste 9850). |
SharedToPartyID |
1..* |
Der oder die Beteiligten, für welche die Informationen zum Update eines Begleitscheins bestimmt sind.Anmerkung: Das EDM Messaging Service liefert nur jene Beteiligten, auf die der abfragende Konnektor Zugriff hat, d.h. nicht notwendigerweise die komplette Liste von Beteiligten, für welche die Informationen bestimmt sind. Dies ist in der Schnittstellenbeschreibung im Abschnitt „Zugriffsrechte“ erläutert. |
ValidationResultItem
Angaben zu einem Prüfprotokolleintrag.
| Name/Typ | min..max | Definition |
|---|---|---|
SevereViolationIndicator |
1..1 |
Ja/Nein-Angabe, ob die einzelne Prüfregelverletzung zu einer “Ablehnung” führt (ob aufgrund der Prüfregelverletzung die Daten technisch nicht verarbeitet werden konnten), oder es sich um einen (für sich allein nicht zur Ablehnung führenden) Hinweis handelt. “Ja” bedeutet, dass eine Ablehnung vorliegt. Insgesamt (für die Gesamtoperation) liegt eine Ablehnung genau dann vor (RejectionIndicator ist auf true), wenn es mindestens einen Ablehnungs-Prüfprotokolleintrag.“Ja” tritt genau bei der Verletzung solcher Prüfregeln auf, die im Prüfregeldokument als zur Ablehnung führend beschrieben sind. |
UserDataDependencyIndicator |
1..1 |
Angabe dazu, ob die Prüfregelverletzung in Zusammenhang mit fachlichen Inhalten (also Inhalten, über die Benutzer Kontrolle haben) steht oder nicht. “Ja” bedeutet, dass ein Zusammenhang mit fachlichen Inhalten besteht. Diese Angabe hilft Clients bei der Handhabung des Prüfprotokolls. Steht der “UserDataDependencyIndicator” auf Nein, liegt jedenfalls ein softwareseitiges, für gewöhnlich nicht durch den Benutzer behebbares Problem vor.Anmerkung: “Nein” liegt für genau solche Prüfregeln vor, die im Prüfregeldokument mit dem Hinweis versehen sind, dass sie in erster Linie die korrekte XML-Repräsentation betreffen. |
ViolatedConstraintID |
1..1 |
Nummer / Identifikationszeichenkette der verletzten Prüfregel. Es handelt sich um genau jene Nummern, die im Prüfregeldokument zu Prüfregeln mit angegeben sind, z.B. in der Form “(ID 1234)”.Anmerkung: Da dieselbe Prüfregel mehrfach verletzt sein kann (z.B. einmal für die Herkunftsangaben, und einmal für die Verbleibsangaben), kann dieselbe Prüfregel-ID mehrfach im Prüfprotokoll auftreten. |
ResultText |
0..1 |
Beschreibung der Prüfregelverletzung (Sprache: Codeliste 7632. Ausschließlich Deutsch). Anmerkung: Die Beschreibungen werden im EDM so gestaltet, dass sie möglichst allgemeinverständlich und gut nachvollziehbar sind. Allerdings kann naturgemäß nur auf die fachlichen Inhalte und das XML-Format Bezug genommen werden. Unter diesem Vorbehalt kann, sofern es sich um eine Prüfregelverletzung handelt, für die der UserDataDependencyIndicator auf “ja” steht, der ResultText durch die Client-Software an den Benutzer “durchgereicht” werden.Benutzer werden vielfach jedoch auch den Bezug zu Elementen der grafischen Benutzeroberfläche im Client erwarten. Ein solcher Bezug kann nur durch die Client-Software hergestellt werden. Vielfach kann die Client-Software den Benutzer viel besser unterstützen, z.B. durch Verweise auf betreffende Elemente der grafischen Benutzeroberfläche, als durch bloßes “Durchreichen” der Prüfregelverletzungs-Beschreibungen. |
ObjectID |
0..* |
Mit dieser ID kann auf “Objekte” in den übermittelten Dateninhalten verwiesen werden, die in Zusammenhang mit der Prüfregelverletzung stehen, z.B. (nicht-natürliche) Personen oder Standorte. Anmerkung 1: In Datenübermittlungs-Prüfprotokollen können sowohl ObjectID als auch CrossReferenceObjectID-Bezüge enthalten sein. ObjectID wird zur Eingrenzung dessen, auf welchen Teil der übermittelten Dateninstanz sich der Prüfprotokolleintrag bezieht, verwendet. CrossReferenceObjectID-Bezüge werden für sonstige Bezüge verwendet, z.B. auf Stammdateneinträge oder andere bereits übermittelte Meldungen oder Deklarationen.Anmerkung 2: Bezugnahmen können beispielsweise mit im EDM zugewiesenen (Personen, Standort oder Anlagen) GLNs erfolgen. Im Attribut collectionID ist dann die GTIN 9008390104026 aus der Codeliste 1756 angegeben. Diese GTIN steht für EDM. |
CrossReferenceObjectID |
0..* |
Mit dieser ID kann auf “Objekte” verwiesen werden, die in Zusammenhang mit der Prüfregelverletzung stehen. Anmerkung 1: In Datenübermittlungs-Prüfprotokollen können sowohl ObjectID als auch CrossReferenceObjectID-Bezüge enthalten sein. ObjectID wird zur Eingrenzung dessen, auf welchen Teil der übermittelten Dateninstanz sich der Prüfprotokolleintrag bezieht, verwendet. CrossReferenceObjectID-Bezüge werden für sonstige Bezüge verwendet, z.B. auf Stammdateneinträge oder andere bereits übermittelte Meldungen oder Deklarationen.Anmerkung 2: Im vorliegenden Webservice wird an dieser Stelle ausschließlich auf bereits zur VEBSV-ID übermittelte Meldungen bzw. Deklarationen Bezug genommen, und zwar mit der vom EDM verwendeten Meldungs-ID (dabei handelt es sich um die für die initiale Übermittlung verwendete Datenübermittlungs-ID bzw. „Transaction ID“). Im Attribut collectionID ist deshalb ausschließlich die GTIN 9008390104026 aus der Codeliste 1756 angegeben. Diese GTIN steht für EDM. |
ReferencedValue |
0..1 |
Handelt es sich bei der Prüfregelverletzung um die “Beanstandung” eines einzelnen Datenwerts, dann kann dieser Wert in “ReferencedValue” mit angegeben werden. Stimmt bei einer übermittelten GLN beispielsweise die Prüfziffer nicht, oder gibt es zu dieser GLN keinen passenden Eintrag im EDM, dann wird in “ReferencedValue” genau diese “beanstandete” GLN zurückgeliefert.Den “beanstandeten Wert” zu kennen, kann dem Benutzer der Client-Software dabei helfen, zu identifizieren, welche Daten welcher Korrektur bedürfen. |
FailureResponse
Angaben zu einem bei der Abarbeitung eines Operationsaufrufs aufgetretenen Fehler.
| Name/Typ | min..max | Definition |
|---|---|---|
FailureID |
0..1 |
Eine ID (Identifikationszeichenkette), die auf einen Eintrag aus Codeliste 5156 “Fehlerkategorien” verweist und solcherart den Fehler klassifiziert. Anmerkung 1: Für den Client-Endanwender ist die Fehlerkategorie im Allgemeinen unverständlich. Die Fehlerkategorie hat vielmehr den folgenden Nutzen: (a) Abhängig von der Fehlerkategorie kann die Client-Software unterschiedlich auf den Fehler reagieren, z.B. einen Datenübermittlungsversuch automatisch wiederholen oder nicht; und (b) die Fehlerkategorie kann für IT-Personal bei Fehlersuche, Tests, Debugging, usw. hilfreich sein.Anmerkung 2: Eine besondere Bedeutung kommt der Fehlerkategorie 203 “Verletzung von Datenanforderungen” zu. Liegt diese Fehlerkategorie vor, dann wird im FailureResponse auch ein sogenanntes Prüfprotokoll geliefert (siehe ValidationResultItem), welches Aufschluss darüber gibt, durch welche der übermittelten Daten welche Datenanforderungen verletzt sind. Das Prüfprotokoll kann mit jener Datenübermittlungs-ID (transaction ID), die im fehlgeschlagenen Operationsaufruf verwendet wurde, zudem auch separat abgerufen werden, und zwar mit der QueryValidationResult-Operation. |
FailureText |
0..1 |
Eine Beschreibung des Fehlers (Sprache: Codeliste 7632. Ausschließlich Deutsch).Anmerkung: Die Beschreibung des Fehlers kann bei der Fehlersuche durch IT-Personal hilfreich sein. Für den Endanwender ist die Fehlerbeschreibung im Allgemeinen unverständlich. Client-Software sollte diesen Text daher nicht, bzw. nicht ohne entsprechenden Kontext, an Benutzer weitergeben. |
ObjectID |
0..1 |
Eine ID aus dem Input an die Operation, mit der auf jenen Teil des Inputs verwiesen wird, der ursächlich für den Fehler ist.Anmerkung: Dieses Datenelement wird im vorliegenden Webservice nicht verwendet. |
ValidationResultItem |
0..* |
Prüfprotokoll, bestehend aus den einzelnen Prüfprotokolleinträgen (Informationen zu einzelnen Verletzungen von Vorgaben). Anmerkung 1: Ein Prüfprotokoll ist im FailureResponse genau dann enthalten, wenn über die FailureID angezeigt wird, dass der Operationsaufruf aufgrund der Verletzung von Datenanforderungen (FailureID 203) fehlgeschlagen ist.Anmerkung 2: Ein im FailureResponse enthaltenes Prüfprotokoll beinhaltet Angaben zu mindestens einer Datenanforderungsverletzung, die zur “Ablehnung” (zum Fehlschlagen der aufgerufenen Operation) führt. Darüber hinaus kann auch eine beliebige Zahl von “Hinweis-Datenanforderungen” verletzt sein, d.h. von Datenanforderungen, deren Verletzung nur einen Hinweis liefert, aber nicht zur Ablehnung bzw. zum Operationsabbruch führt. Auch zu allen solchen festgestellten Datenanforderungsverletzungen sind Angaben im Prüfprotokoll enthalten. |
ShareDocumentRequest
Input der ShareDocument-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
AgentPersonName |
0..1 |
Name der Person (des Client-Benutzers), deren Interaktion mit der Client-Software die Interaktion der Client-Software mit dem Webservice ausgelöst hat. Anmerkung 1: Es handelt sich hierbei um eine "private" Angabe, die ausschließlich für das bei der Webservice-Interaktion authentifizierte Unternehmen mitprotokolliert wird, aber nicht an andere Unternehmen oder Behörden weitergegeben wird. Anmerkung 2: Durch Übermittlung dieser Angabe kann die Nachvollziehbarkeit, wie Webservice-Interaktionen zustandekommen, erhöht werden.Anmerkung 3: Die Angabe des Namens an dieser Stelle ist vor allem für den Fall gedacht, dass die bei der Webservice-Interaktion (per EDM-Benutzername und unter Verwendung des Application Passwords generierten HMAC) authentifizierte Person eine andere Person ist, als diejenige, welche die Webservice-Interaktion unmittelbar ausgelöst hat. Damit kann für diejenigen Personen, die EDM-Benutzername und Application Password in Drittsoftware hinterlegen, nachvollziehbar und kontrollierbar gemacht werden, welche Webservice-Interaktionen in ihrem Namen erfolgen. |
AgentTelephoneCommunicationNetworkEndpointID |
0..1 |
Telefonnummer des Benutzers, dessen Interaktion mit der Client-Software die Interaktion der Client-Software mit dem Webservice ausgelöst hat. Anmerkung 1: Es handelt sich hierbei um eine "private" Angabe, die ausschließlich für das bei der Webservice-Interaktion authentifizierte Unternehmen mitprotokolliert wird, aber nicht an andere Unternehmen oder Behörden weitergegeben wird. Anmerkung 2: Durch Übermittlung dieser Angabe kann die Nachvollziehbarkeit, wie Webservice-Interaktionen zustandekommen, erhöht werden.Anmerkung 3: Die Angabe der Telefonnummer an dieser Stelle ist vor allem für Fälle vorgesehen, in welchen zunächst beim Versand einer Message in der Liste von Empfängern Telefonnummern für SMS-Benachrichtigungen angegeben werden. Erfolgt in Folge von einem dieser Empfänger das Versenden einer Antwort- oder Follow-Up-Message, und spielt dabei das Öffnen einer per SMS erhaltenen URL eine Rolle bei der Identifikation dieses Empfängers, dass sollte beim Versender der Antwort- oder Follow-Up-Message diese Telefonnummer mit angegeben sein. |
TransactionUUID |
1..1 |
Eine vom Client speziell für den konkreten ShareDocument-Aufruf generierte UUID (Universally Unique ID). Anmerkung 1: Mit dieser UUID kann in Folge auf den ShareDocument-Aufruf Bezug genommen werden, z.B. beim Aufruf der ShareRetrieverStatus-Operation (backward sharing). Anmerkung 2: Auch bei Verwendung der Operation zur Korrektur von zuvor übermittelten Daten wird an dieser Stelle eine neu generierte ID benötigt.Anmerkung 3: Wird eine bereits „verbrauchte“ (d.h. zuvor in einer schreibenden Operation verwendete) UUID angegeben, führt dies zum SOAP-Fault. |
Recipient |
0..* |
Der oder die Empfänger bzw. Adressaten der „Vorwärts-Transaktion“ (des Verteilens einer Message oder des Verteilens einer Message-Korrektur). |
AuthenticatedDocument |
1..1 |
Die Message, die initial oder zur Korrektur verteilt wird, zusammen mit Metadaten. |
ShareDocumentResponse
Output der ShareDocument-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ResponseTypeID |
0..1 |
Dem Wert, der in diesem Element als Response geliefert wird, kommt gegenwärtig keine Bedeutung zu.Anmerkung: Die ShareDocument-Operation wird vom EDM Messaging Service asynchron abgearbeitet. Ob der ShareDocument-Aufruf erfolgreich abgearbeitet werden konnte, muss der Client/Konnektor daher per separaten Aufrufen (QueryUpdate) feststellen. |
ShareDocumentCancellationRequest
Input der ShareDocumentCancellation-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
AgentPersonName |
0..1 |
Name der Person (des Client-Benutzers), deren Interaktion mit der Client-Software die Interaktion der Client-Software mit dem Webservice ausgelöst hat. Anmerkung 1: Es handelt sich hierbei um eine "private" Angabe, die ausschließlich für das bei der Webservice-Interaktion authentifizierte Unternehmen mitprotokolliert wird, aber nicht an andere Unternehmen oder Behörden weitergegeben wird. Anmerkung 2: Durch Übermittlung dieser Angabe kann die Nachvollziehbarkeit, wie Webservice-Interaktionen zustandekommen, erhöht werden.Anmerkung 3: Die Angabe des Namens an dieser Stelle ist vor allem für den Fall gedacht, dass die bei der Webservice-Interaktion (per EDM-Benutzername und unter Verwendung des Application Passwords generierten HMAC) authentifizierte Person eine andere Person ist, als diejenige, welche die Webservice-Interaktion unmittelbar ausgelöst hat. Damit kann für diejenigen Personen, die EDM-Benutzername und Application Password in Drittsoftware hinterlegen, nachvollziehbar und kontrollierbar gemacht werden, welche Webservice-Interaktionen in ihrem Namen erfolgen. |
AgentTelephoneCommunicationNetworkEndpointID |
0..1 |
Telefonnummer des Benutzers, dessen Interaktion mit der Client-Software die Interaktion der Client-Software mit dem Webservice ausgelöst hat. Anmerkung 1: Es handelt sich hierbei um eine "private" Angabe, die ausschließlich für das bei der Webservice-Interaktion authentifizierte Unternehmen mitprotokolliert wird, aber nicht an andere Unternehmen oder Behörden weitergegeben wird. Anmerkung 2: Durch Übermittlung dieser Angabe kann die Nachvollziehbarkeit, wie Webservice-Interaktionen zustandekommen, erhöht werden.Anmerkung 3: Die Angabe der Telefonnummer an dieser Stelle ist vor allem für Fälle vorgesehen, in welchen zunächst beim Versand einer Message in der Liste von Empfängern Telefonnummern für SMS-Benachrichtigungen angegeben werden. Erfolgt in Folge von einem dieser Empfänger das Versenden einer Antwort- oder Follow-Up-Message, und spielt dabei das Öffnen einer per SMS erhaltenen URL eine Rolle bei der Identifikation dieses Empfängers, dass sollte beim Versender der Antwort- oder Follow-Up-Message diese Telefonnummer mit angegeben sein. |
TransactionUUID |
1..1 |
Eine vom Konnektor speziell für den konkreten ShareDocumentCancellation-Aufruf generierte UUID (Universally Unique ID). |
Recipient |
0..* |
Der oder die Empfänger bzw. Adressaten des Stornierens (des Verteilens der Stornierung).Anmerkung: Für gewöhnlich wird eine Stornierung an alle Beteiligten weitergegeben, an welche zuvor die nunmehr stornierte Message weitergegeben wurde. |
AuthenticatedCancellation |
1..1 |
Die Inhalte der Stornierung, z.B. die UUID der zu stornierenden „Kette von Messages“ und der Stornierungsgrund. |
ShareDocumentCancellationResponse
Output der ShareDocumentCancellation-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ResponseTypeID |
0..1 |
Dem Wert, der in diesem Element als Response geliefert wird, kommt gegenwärtig keine Bedeutung zu.Die ShareDocumentCancellation-Operation wird vom EDM Messaging Service asynchron abgearbeitet. Ob der ShareDocumentCancellation-Aufruf erfolgreich abgearbeitet werden konnte, muss der Client/Konnektor daher per separaten Aufrufen (QueryUpdate) feststellen. |
QueryDocumentValidationResultRequest
Input der QueryDocumentValidationResult-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
ReferredTransactionUUID |
1..1 |
Die Transaction ID, die in jenem Datenübermittlungs-, Datenkorrektur- bzw. Datenstornierungs-Aufruf verwendet wurde, zu dem ein Prüfprotokoll abgerufen wird. |
QueryDocumentValidationResultResponse
Output der QueryDocumentValidationResult-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ValidationResultItem |
0..* |
Informationen zu einzelnen Verletzungen von Vorgaben. |
QueryUpdateRequest
Input der QueryUpdate-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
UpdateRangeStartUUID |
1..1 |
Die untere Begrenzung für den ID-Bereich abzurufender Updates. Anmerkung 1: Ob der Bereich inklusive oder exklusive UpdateRangeStartUUID abgefragt wird, kann über das UpdateRangeStartInclusionIndicator-Element gesteuert werden (Voreinstellung: inklusive). Anmerkung 2: Die QueryUpdate-Operation dient in erster Linie dazu, dass ein Konnektor für eine DB „neue“, noch nicht bekannte Updates abruft. Dazu wird die letzte Update-UUID aus dem Output des letzten QueryUpdate-Aufrufs („letzte“ in Bezug auf die Reihenfolge der Updates im QueryUpdate-Output) als UpdateRangeStartUUID -Input an den nächsten QueryUpdate-Aufruf übergeben, zusammen mit einem auf false gesetzten UpdateRangeStartInclusionIndicator. Anmerkung 3: In Fällen, in welchen keine Update-UUID aus dem Output eines vorangegangenen QueryUpdate-Aufrufs bekannt ist (z.B. weil es sich um den ersten QueryUpdate-Aufruf handelt), kann die sogenannte nil UUID verwendet werden (00000000-0000-0000-0000-000000000000). Mit dieser entfällt die untere Begrenzung für den Bereich abzurufender Updates. Dabei ist zu beachten, dass(a) die Abfragbarkeit von Updates mit der QueryUpdate-Operation durch das EDM Messaging Service nur für Updates der letzten 7 Wochen garantiert wird, und „ältere“ Updates im Output der QueryUpdate-Operation somit ggf. fehlen; und (b) dass es unzulässig ist, die QueryUpdate-Operation wiederholt mit der nil UUID als UpdateRangeStartUUID aufzurufen. |
UpdateRangeEndUUID |
0..1 |
Die obere Begrenzung für den ID-Bereich abzurufender Updates. Anmerkung 1: Ob der Bereich inklusive oder exklusive UpdateRangeEndID abgefragt wird, kann über das UpdateRangeEndInclusionIndicator-Element gesteuert werden (Voreinstellung: inklusive).Anmerkung 2: Eine obere Begrenzung für den ID-Bereich sollte im Allgemeinen nur dann angegeben werden, wenn ein dem Konnektor bereits bekannter Update-ID-Bereich (erneut) abgefragt wird. Die QueryUpdate-Operation dient allerdings in erster Linie dazu, neue, noch nicht bekannte Updates abzurufen. Für das Abrufen neuer Updates ist keine obere Begrenzung für den ID-Bereich abzurufender Updates anzugeben (das UpdateRangeEndID-Element entfällt). |
UpdateRangeStartInclusionIndicator |
0..1 |
Angabe, ob die Updates inklusive jenem mit der in UpdateRangeStartID angegebenen ID abgefragt werden sollen. Anmerkung 1: Wenn QueryUpdate für die Abfrage neuer Updates verwendet wird, dann wird für gewöhnlich die letzte dem Client aus früheren Update-Abrufen bekannte Update-ID als UpdateRangeStartUUID übergeben, in UpdateRangeStartInclusionIndicator der Wert false übergeben, und UpdateRangeEndID nicht gesetzt.Anmerkung 2: Bei fehlender UpdateRangeStartInclusionIndicator-Angabe erfolgt die Abfrage inklusive UpdateRangeStartID (Inklusion ist die Voreinstellung). |
UpdateRangeEndInclusionIndicator |
0..1 |
Angabe, ob die Updates inklusive jenem mit der in UpdateRangeEndID angegebenen ID abgefragt werden sollen. Anmerkung 1: Bei fehlender UpdateRangeEndInclusionIndicator-Angabe erfolgt die Abfrage inklusive UpdateRangeEndID (Inklusion ist die Voreinstellung).Anmerkung 2: Wird UpdateRangeEndID nicht gesetzt, dann wirkt sich ein allfällig gesetzter UpdateRangeEndInclusionIndicator–Wert nicht auf die Operation aus. |
QueryUpdateResponse
Output der QueryUpdate-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
AdditionalUpdatesIndicator |
1..1 |
Ja/Nein-Angabe dazu, ob über die im Output der QueryUpdate-Operation zurückgelieferten Updates weitere Updates vorliegen und den im Input der QueryUpdate-Operation angegebenen Kriterien entsprechen.Anmerkung: Diese Systematik ist dafür vorgesehen, die Größe des Outputs der QueryUpdate-Operation sowie die Antwortzeiten zu begrenzen. Unter Umständen liefert die QueryUpdate-Operation nicht die Liste aller n Updates, die in den im Operations-Input angegebenen ID-Bereich fallen, sondern nur die ersten m (m kleiner n) Updates. In diesem Fall wird der AdditionalUpdatesIndicator im Output der QueryUpdate-Operation auf true gesetzt, und die Abfrage der Gesamtheit aller Updates kann iterativ mit mehreren QueryUpdate-Aufrufen erfolgen. |
Update |
0..* |
Ein einzelnes Update, z.B. mit Angaben zu einem forward sharing (Verteilen einer Message, einer Korrektur oder einer Stornierung). Anmerkung 1: Die Reihenfolge von Updates im Output von QueryUpdate-Aufrufen (die Reihenfolge von Instanzen des Update-Elements) entspricht der durch das EDM Messaging Service für Updates definierten Reihenfolge. Allerdings ist der Output von QueryUpdate-Aufrufen naturgemäß auf solche Updates beschränkt, auf welche Zugriff besteht. Anmerkung 2: Es gibt die folgenden Arten von Updates: - ForwardSharingEvent: Angaben zu einem erfolgreichen forward sharing. Ein einzelner schreibender Zugriff auf das EDM Messaging Service (Aufruf von forward sharing Operationen) kann höchstens ein ForwardSharingEvent auslösen. - BackwardSharingEvent: Angaben zu einem erfolgreichen backward sharing. Ein einzelner schreibender Zugriff auf das EDM Messaging Service (Aufruf von backward sharing Operationen) kann höchstens ein BackwardSharingEvent auslösen. - ProcessingEvent: Vom EDM Messaging Service erstellte Rückmeldung zum Aufruf einer asynchronen schreibenden Operation. Wird bislang ausschließlich in solchen Fällen geliefert, in welchen ein forward sharing oder backward sharing fehlschlägt. - PostProcessingEvent: Informationen zu in Folge der erfolgreichen Verarbeitung durch das EDM Messaging Service erfolgenden Interaktionen mit externen Systemen, z.B. zur SMS-Benachrichtigung. - UpdateSignalEvent: Benachrichtigung dazu, dass es Änderungen an einem vollelektronischen Begleitschein gibt (von der EDM VEBSV Anwendung generierte und an das EDM Messaging Service weitergegebene Benachrichtigung). Anmerkung 3: Asynchrone schreibende Operationen generieren, sofern sie nicht unmittelbart fehlschlagen (SOAP-Fault), die folgenden Updates: (a) Genau ein Update, bei dem es sich entweder um ein ForwardSharingEvent, ein BackwardSharingEvent oder ein ProcessingEvent handelt. (b) Beliebig viele ("0 bis n") PostProcessingEvents.Anmerkung 4: ProcessingEvents und PostProcessingEvents sind immer nur dem Aufrufenden der schreibenden Operation zugänglich, nicht jedoch allfällig in der schreibenden Operation angegeben Empfängern. Die "Sharing-Events" sind hingegen sowohl Aufrufenden als auch Empfängern zugänglich. |
RetrieveDocumentRequest
Input der RetrieveDocument-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
ReferredTransactionUUID |
1..1 |
Die Datenübermittlungs-ID (transaction ID) aus einer forward sharing Operation, die zum Teilen einer Message oder zum Teilen einer Message-Korrektur genutzt wurde. Mit der RetrieveDocument-Operation wird in Folge die zu dieser forward sharing Operation gehörige Message (ggf. mitsamt Anhängen und Darstellunsgformaten) abgerufen. |
RequestStandardFormatHTMLIndicator |
0..1 |
Wird dieser Ja/Nein-Wert auf Ja (true) gesetzt, dann wird die Message zusätzlich zum strukturierten elektronischen Format, z.B. XML-Instanz, auch in einem vom EDM Messaging Service generierten einheitlichen Darstellungsformat, im HTML-Format mit inkludiertem CSS-Stylesheet, abgerufen, sofern dies für den betreffenden Message-Typ unterstützt wird. |
RequestStandardFormatPDFIndicator |
0..1 |
(zurzeit nicht unterstützt) Wird dieser Ja/Nein-Wert auf Ja (true) gesetzt, dann wird die Message zusätzlich zum strukturierten elektronischen Format, z.B. XML-Instanz, auch in einem vom EDM Messaging Service generierten einheitlichen Darstellungsformat, im PDF-Format, abgerufen, sofern dies für den betreffenden Message-Typ unterstützt wird. |
RequestEncryptedResponse |
0..1 |
(zurzeit nicht unterstützt) Wird dieser Ja/Nein-Wert auf Ja (true) gesetzt, dann wird das angefragte Dokument mit dem im Messaging-System hinterlegten Public-Key des Benutzers verschlüsselt. |
RetrieveDocumentResponse
Output der RetrieveDocument-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ForwardSharingEvent |
1..1 |
Die Angaben zum forward sharing, auf welches mit den RetrieveDocument-Parametern Bezug genommen wurde. |
AuthenticatedDocument |
0..1 |
Die abgerufene Message mitsamt Metadaten und Anhängen sowie allfälligen Siegeln und Signaturen. |
StandardFormatHTMLBinaryObject |
0..1 |
(zurzeit nicht unterstützt) In diesem Element wird der Message-Inhalt in einer formatierten Darstellung übermittelt, und zwar als HTML-Instanz mit eingebettetem CSS Stylesheet. Anmerkung 1: Die formatierte Darstellung wird base64-codiert übermittelt (siehe https://www.w3.org/TR/xmlschema-2/#base64Binary). Anmerkung 2: Diese formatierte Darstellung wird nur dann geliefert, wenn sie über die RetrieveDocument-Request-Parameter angefordert wurde, und für den betreffenden Message-Typ eine solche Darstellung verfügbar ist. Anmerkung 3: Nähere Erläuterungen zur einheitlichen Darstellung von Messages sind in der Schnittstellenbeschreibung angegeben.Anmerkung 4: Die XML-Attribute beschreiben den Inhalt näher. Die Attribute sind dieselben wie jene des AttachmentBinaryObject-Elements aus der Document-Struktur. |
StandardFormatPDFBinaryObject |
0..1 |
(zurzeit nicht unterstützt) In diesem Element wird der Message-Inhalt in einer formatierten Darstellung übermittelt, und zwar als PDF-Datei. Anmerkung 1: Die formatierte Darstellung wird base64-codiert übermittelt (siehe https://www.w3.org/TR/xmlschema-2/#base64Binary). Anmerkung 2: Diese formatierte Darstellung wird nur dann geliefert, wenn sie über die RetrieveDocument-Request-Parameter angefordert wurde, und für den betreffenden Message-Typ eine solche Darstellung verfügbar ist. Anmerkung 3: Nähere Erläuterungen zur einheitlichen Darstellung von Messages sind in der Schnittstellenbeschreibung angegeben.Anmerkung 4: Die XML-Attribute beschreiben den Inhalt näher. Die Attribute sind dieselben wie jene des AttachmentBinaryObject-Elements aus der Document-Struktur. . |
ShareRetrieverStatusRequest
Input der ShareRetrieverStatus-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
TransactionUUID |
1..1 |
Eine vom Konnektor speziell für den konkreten ShareRetrieverStatus-Aufruf generierte UUID (Universally Unique ID). |
ReferredTransactionUUID |
1..1 |
Transaction UUID (Universally Unique ID) des forward sharing Aufrufs, zu dessen Verarbeitung per backward sharing eine Rückmeldung erfolgt. |
ReferredTransactionTypeID |
1..1 |
Art des forward sharing, z.B. initiales Verteilen, Verteilen einer Korrektur oder Stornieren (Codeliste 6413), zu dessen Verarbeitung eine Rückmeldung erfolgt. |
SharedByPartyID |
0..1 |
Die in den EDM Stammdaten zugewiesene GLN (Global Location Number) für jenen Beteiligten, der als „Absender“ des backward sharing fungiert. Anmerkung: Backward sharing gibt es in 2 Ausprägungen: a) Rückmeldungen zur „Validierung und Speicherung“ (bei der Übernahme in die Ziel-DB). Dies ist eine vom empfangenden Konnektor generierte Rückmeldung, und nicht eine von einem einzelnen Beteiligten generierte Rückmeldung. Beim ShareRetrieverStatus-Aufruf für „Validierung und Speicherung“ wird deshalb unter SharedByPartyID kein Beteiligter angegeben. Damit jede Verarbeitungsrückmeldung auf Seite des Versenders einer Message dennoch Beteiligten zuordenbar ist, stellt das EDM Messaging Service eine solche Zuordnung her.b) „Durchsicht und Prüfung durch Benutzer“ (Bestätigungsmessage). Dabei handelt es sich um eine Rückmeldung, bei der ein identifizierter Benutzer eine Übergabe/Übernahme-Message inhaltlich bestätigt. Hierbei muss unter SharedByPartyID ein Beteiligter (jener, der die Bestätigung melden möchte) angegeben werden. Das ist in der Schnittstellenbeschreibung erläutert. |
SharedToPartyID |
1..1 |
Der Empfänger des backward sharing (des Verteilens einer Verarbeitungsrückmeldung).Anmerkung: Der Empfänger eines backward sharing muss mit dem Absender des forward sharing übereinstimmen, auf welches sich das backward sharing bezieht. |
OperationTypeID |
1..1 |
Die auf Seite des forward sharing Empfängers durchgeführte Operation bzw. Aktivität, auf die sich die per backward sharing verteilte Rückmeldung bezieht (Codeliste 6801).Anmerkung: An dieser Stelle können gegenwärtig die Werte „Validierung und Speicherung“ (Übernahme in die Ziel-DB) und „Durchsicht und Prüfung durch Benutzer“ (Bestätigungsmessage) angegeben werden. |
OperationStatusID |
1..1 |
Der Status der in OperationTypeID angegebenen Verarbeitungsoperation, z.B. Erfolg, Erfolg mit Hinweisen, oder Fehler (Codeliste 2089). |
StatusReasonID |
0..1 |
Einer aus einer vordefinierten Liste von Gründen für den Status der Verarbeitungsoperation bzw. Bearbeitungsaktivität (Codeliste 6838). Anmerkung 1: Die Auswahl eines Grunds ist im Allgemeinen nur im Fehlerfall angegeben (OperationStatusID zeigt an, dass ein Fehler vorliegt).Anmerkung 2: Wenn der Grund für den Status ein anderer ist, als einer, der in Codeliste 6838 definiert ist, dann entfällt die StatusReasonID-Angabe. In diesem Fall soll StatusDecription angegeben sein, und Angaben zum Grund für den Status bzw. Fehler beinhalten. |
StatusDescription |
0..1 |
Textuelle Beschreibung des Status der Verarbeitungsoperation bzw. Bearbeitungsaktivität (Sprache: Codeliste 7632. Ausschließlich Deutsch). |
ShareRetrieverStatusResponse
Output der ShareRetrieverStatus-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ResponseTypeID |
0..1 |
Dem Wert, der in diesem Element als Response geliefert wird, kommt gegenwärtig keine Bedeutung zu.Die ShareRetrieverStatus-Operation wird vom EDM Messaging Service asynchron abgearbeitet. Der Ablauf ist in der Schnittstellenbeschreibung erläutert. |
ShareSignalRequest
Input der ShareSignal-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
TransactionUUID |
1..1 |
Eine vom Konnektor speziell für den konkreten ShareSignal-Aufruf generierte UUID (Universally Unique ID). |
UpdateSignal |
1..1 |
Angaben zu dem zu verteilenden Signal und zu den Adressaten des Signals. |
ShareSignalResponse
Output der ShareSignal-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ResponseTypeID |
0..1 |
Dem Wert, der in diesem Element als Response geliefert wird, kommt gegenwärtig keine Bedeutung zu. Die ShareSignal-Operation wird vom EDM Messaging Service asynchron abgearbeitet. Ob der ShareSignal-Aufruf erfolgreich abgearbeitet werden konnte, muss der Client/Konnektor daher per separaten Aufrufen (QueryUpdate) feststellen. |
RefreshBindingRequest
Input der RefreshBinding-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
TransactionUUID |
1..1 |
Eine vom Konnektor speziell für den konkreten RefreshBinding-Aufruf generierte UUID (Universally Unique ID). |
RefreshBindingResponse
Output der RefreshBinding-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ResponseTypeID |
0..1 |
Dem Wert, der in diesem Element als Response geliefert wird, kommt gegenwärtig keine Bedeutung zu. |
LaunchDocumentActionEvent
Angaben zu einem LaunchDocumentAction.
| Name/Typ | min..max | Definition |
|---|---|---|
TransactionUUID |
1..1 |
Eine vom Konnektor speziell für den konkreten LaunchDocumentAction-Aufruf generierte UUID (Universally Unique ID). |
OperationTypeID |
1..1 |
Die vom EDM Messaging Service durchgeführte Operation, auf die sich die Verarbeitungsrückmeldung bezieht (Codeliste 6801).Anmerkung: An dieser Stelle ist ausschließlich die „Validierung und Speicherung“ vorgesehen. |
OperationStatusID |
1..1 |
Der Status der in OperationTypeID angegebenen Verarbeitungsoperation, z.B. Erfolg, Erfolg mit Hinweisen, oder Fehler (Codeliste 2089). |
StatusReasonID |
0..1 |
Einer aus einer vordefinierten Liste von Gründen für den Status der Verarbeitungsoperation (Codeliste 1701).Anmerkung: Wenn der Grund für den Status ein anderer ist, als einer, der in Codeliste 1701 definiert ist, dann entfällt die StatusReasonID-Angabe. In diesem Fall ist nur StatusDecription angegeben, mit Angaben zum Grund für den Status bzw. Fehler beinhalten. |
StatusDescription |
0..1 |
Textuelle Beschreibung des Status der Verarbeitung durch das EDM Messaging Service (Sprache: Codeliste 7632. Ausschließlich Deutsch). |
TransportMovementUUID |
1..1 |
UUID des Transportes, für den das Transportdokument erstellt wurde. |
LaunchDocumentActionRequest
Input der LaunchDocumentAction-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
InterfaceVersionID |
1..1 |
Konstante, die der Konnektor an die Webservice-Operation übergibt, und die angibt, auf welche Version des Webservice der Konnektor ausgelegt ist. |
ConnectorVersionID |
1..1 |
Version des Konnektors, der den Operations-Aufruf durchführt. |
InteroperabilityProfileID |
0..1 |
Aus Gründen der Rückwärtskompatibilität ist dieses Element noch vorhanden, wird jedoch nicht mehr verwendet. |
AgentPersonName |
0..1 |
Name der Person (des Client-Benutzers), deren Interaktion mit der Client-Software die Interaktion der Client-Software mit dem Webservice ausgelöst hat. Anmerkung 1: Es handelt sich hierbei um eine "private" Angabe, die ausschließlich für das bei der Webservice-Interaktion authentifizierte Unternehmen mitprotokolliert wird, aber nicht an andere Unternehmen oder Behörden weitergegeben wird. Anmerkung 2: Durch Übermittlung dieser Angabe kann die Nachvollziehbarkeit, wie Webservice-Interaktionen zustandekommen, erhöht werden.Anmerkung 3: Die Angabe des Namens an dieser Stelle ist vor allem für den Fall gedacht, dass die bei der Webservice-Interaktion (per EDM-Benutzername und unter Verwendung des Application Passwords generierten HMAC) authentifizierte Person eine andere Person ist, als diejenige, welche die Webservice-Interaktion unmittelbar ausgelöst hat. Damit kann für diejenigen Personen, die EDM-Benutzername und Application Password in Drittsoftware hinterlegen, nachvollziehbar und kontrollierbar gemacht werden, welche Webservice-Interaktionen in ihrem Namen erfolgen. |
AgentTelephoneCommunicationNetworkEndpointID |
0..1 |
Telefonnummer des Benutzers, dessen Interaktion mit der Client-Software die Interaktion der Client-Software mit dem Webservice ausgelöst hat. Anmerkung 1: Es handelt sich hierbei um eine "private" Angabe, die ausschließlich für das bei der Webservice-Interaktion authentifizierte Unternehmen mitprotokolliert wird, aber nicht an andere Unternehmen oder Behörden weitergegeben wird. Anmerkung 2: Durch Übermittlung dieser Angabe kann die Nachvollziehbarkeit, wie Webservice-Interaktionen zustandekommen, erhöht werden.Anmerkung 3: Die Angabe der Telefonnummer an dieser Stelle ist vor allem für Fälle vorgesehen, in welchen zunächst beim Versand einer Message in der Liste von Empfängern Telefonnummern für SMS-Benachrichtigungen angegeben werden. Erfolgt in Folge von einem dieser Empfänger das Versenden einer Antwort- oder Follow-Up-Message, und spielt dabei das Öffnen einer per SMS erhaltenen URL eine Rolle bei der Identifikation dieses Empfängers, dass sollte beim Versender der Antwort- oder Follow-Up-Message diese Telefonnummer mit angegeben sein. |
TransactionUUID |
1..1 |
Eine vom Konnektor speziell für den konkreten LaunchDocumentAction-Aufruf generierte UUID (Universally Unique ID). |
TransportMovementUUID |
1..1 |
UUIDs jener zuvor über das EDM Messaging Service ausgetauschten Messages, auf welche die Aktion angewandt werden soll. Anmerkung 1: Die Aktion kann nur auf solche Messages angewandt werden, auf die Zugriff besteht, z.B. weil die Message vom Beteiligten, der Aufrufender der LaunchDocumentAction-Operation ist, zuvor verteilt oder empfangen wurde.Anmerkung 2: Wurde eine Message mit der betreffenden UUID von demjenigen Beteiligten, der Aufrufer der LaunchDocumentAction-Operation ist, mehrfach geteilt oder empfangen, dann wird für die Operation die Inhalts-Instanz mit der höchsten im EDM Messaging Service zugewiesenen Reihenfolge-Zahl herangezogen. Dabei handelt es sich für gewöhnlich um die jüngste geteilte oder empfangene Inhalts-Instanz mit dieser DocumentUUID. Die Reihenfolge ist in der Schnittstellenbeschreibung unter der QueryUpdate-Operation erläutert. |
ActionTypeID |
1..1 |
Art der Aktion, welche auf die ausgewählten Messages angewandt werden soll (Codeliste 1276). Anmerkung: Es gibt bisher nur eine implementierte Aktion (generateTransportInformationAccessLink) namentlich die Erzeugung des Transportdokuments, welches z.B. in Kontroll-Situationen, etwa einer Straßenkontrolle, vorgewiesen werden kann. |
LaunchDocumentActionResponse
Output der LaunchDocumentAction-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
ResponseTypeID |
0..1 |
Dem Wert, der in diesem Element als Response geliefert wird, kommt gegenwärtig keine Bedeutung zu. |
PublicKeyRequest
Input der Public Key Abfrage-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
UserID |
1..1 |
Die GLN der Person oder spezielle IDs. Mit "messaging" erhält man den Public Key des Messaging WebService. |
PublicKeyResponse
Output der Public Key Abfrage-Operation.
| Name/Typ | min..max | Definition |
|---|---|---|
PublicKey |
0..1 |
Der öffentliche Schlüssel des registrierten Benutzers, bzw. von Messaging. Wurde eine falsche GLN übermittelt oder hat der registrierte Benutzer noch keinen Schlüssel erstellt, so ist dieser Wert leer. |
Datentypen
AssignmentIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
AssignmentIdentifier ms:Token64 |
1..1 |
Einem Objekt zugeordneter, in einem bestimmten Kontext eindeutiger, und somit in diesem Kontext für die Objektidentifikation geeigneter Wert. Z.B. eine zu einer Firma angegebene Firmenbuchnummer. Zusätzlich zu dem das Objekt identizierenden Wert (Identifikator) erfolgt die Identifikation der Sammlung von Identifikatoren (z.B. Register oder Codeliste, etwa Firmenbuch oder Straßenverzeichnis), der der Wert entstammt. |
BinaryObject
| Name/Typ | min..max | Definition |
|---|---|---|
BinaryObject |
1..1 |
Eine als Text repräsentierte Bytefolge (z.B. Datei), zusammen mit beschreibenden Attributen (z.B. Dateiname). |
typeID Token64 |
1..1 |
Art der Bytefolge bzw. Datei (Codeliste 5988). |
mimeCode Token64 |
1..1 |
Multipurpose Internet Mail Extensions (MIME) Content-Type Code. Ein solcher Code definiert den Inhalts- bzw. Dateityp, etwa PDF oder PNG. Es sind nicht sämtliche MIME Content Types zulässig, sondern nur die in Codeliste 5563 enthaltenen. |
encodingCode Token64 |
1..1 |
Ein Multipurpose Internet Mail Extension (MIME) Content Transfer Encoding code der die Art der Repräsentation der Bytefolge als Text angibt.Anmerkung: Es sind nicht sämtliche Transfer-Encoding-Codes zulässig, sondern nur die in Codeliste 2310 enthaltenen. In Codeliste 2310 ist genau eine Codierungsart enthalten, und zwar “base64”, der für die sogenannte Base64-Codierung steht. |
filename NormalizedString256 |
1..1 |
(Empfohlener) Dateiname für die Bytefolge bzw. Datei, z.B. „Lieferschein.pdf“, inklusive einer allfälligen Dateinamenserweiterung bzw. Dateisuffix (z.B. „.pdf“ im genannten Beispiel). |
BinaryObjectContent
| Name/Typ | min..max | Definition |
|---|---|---|
BinaryObjectContent xs:base64Binary |
1..1 |
Eine Bytefolge in Base64-Codierung. |
DateTime
| Name/Typ | min..max | Definition |
|---|---|---|
DateTime xs:dateTime |
1..1 |
Zeitpunkt (Datum und Uhrzeit). |
DescriptionText
| Name/Typ | min..max | Definition |
|---|---|---|
DescriptionText |
1..1 |
Beschreibungstext, zusammen mit einem Attribut, welches die Sprache angibt. |
languageID StrictToken64 |
1..1 |
Sprache, in welcher der Beschreibungstext verfasst ist (Codeliste 7632). |
Indicator
| Name/Typ | min..max | Definition |
|---|---|---|
Indicator xs:boolean |
1..1 |
Ja/Nein-Wert (Ja: Eigenschaft trifft zu; Nein: Eigenschaft trifft nicht zu). |
NameText
| Name/Typ | min..max | Definition |
|---|---|---|
NameText xs:normalizedString |
1..1 |
Name. |
NonNegativeInteger8
| Name/Typ | min..max | Definition |
|---|---|---|
NonNegativeInteger8 xs:nonNegativeInteger |
1..1 |
Nichtnegative ganze Zahl bestehend aus bis zu 8 Dezimalziffern. |
NormalizedString256
| Name/Typ | min..max | Definition |
|---|---|---|
NormalizedString256 xs:normalizedString |
1..1 |
Zeichenkette, die aus maximal 256 Zeichen und aus mindestens 1 Zeichen besteht, und die normalisiert ist.Anmerkung: Eine Zeichenkette gilt genau dann als normalisiert, wenn sie weder Carriage Return (#xD), Line Feed (#xA) noch Tabulatur (#x9) enthält. |
OptionalTypeReferenceIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
OptionalTypeReferenceIdentifier |
1..1 |
Referenzierung eines Objekts durch Angabe eines dem Objekt zugeordneten Identifikators. Zusätzlich zum Objekt-Identifkator wird die Identifikation der Sammlung von Identifikatoren (z.B. Register oder Codeliste, etwa Abfallverzeichnis) angegeben, der der Identifikator entstammt. |
collectionID StrictToken64 |
1..1 |
|
objectTypeName NameText |
0..1 |
PredeterminedScopeReferenceIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
PredeterminedScopeReferenceIdentifier |
1..1 |
Referenzierung eines Objekts durch Angabe eines dem Objekt zugeordneten Identifikators. |
ReferenceIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
ReferenceIdentifier |
1..1 |
Referenzierung eines Objekts durch Angabe eines dem Objekt zugeordneten Identifikators. Zusätzlich zum Objekt-Identifkator wird die Identifikation der Sammlung von Identifikatoren (z.B. Register oder Codeliste, etwa Abfallverzeichnis) angegeben, der der Identifikator entstammt. |
collectionID StrictToken64 |
1..1 |
|
objectDesignation NormalizedString256 |
0..1 |
StrictReferenceIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
StrictReferenceIdentifier |
1..1 |
Referenzierung eines Objekts durch Angabe eines dem Objekt zugeordneten Identifikators.Anmerkung: Der Identifikator hat einen einfachen Aufbau zu besitzen. Insbesondere hat er keine anderen Zeichen zu enthalten als Großbuchstaben, Kleinbuchstaben, Ziffern, Bindestrich und Unterstrich. Zudem haben Bindestrich und Unterstrich weder zu Beginn noch zu Ende der Zeichenkette aufzutreten. |
StrictToken64
| Name/Typ | min..max | Definition |
|---|---|---|
StrictToken64 xs:token |
1..1 |
Zeichenkette, die aus maximal 64 und aus mindestens 1 Zeichen besteht, und die aus keinen anderen Zeichen besteht als Großbuchstaben, Kleinbuchstaben, Ziffern, Bindestrich und Unterstrich, wobei Bindestrich und Unterstrich weder zu Beginn noch zu Ende der Zeichenkette auftreten. |
String1024
| Name/Typ | min..max | Definition |
|---|---|---|
String1024 xs:string |
1..1 |
Zeichenkette, die aus maximal 1024 und aus mindestens 1 Zeichen besteht. |
TelephoneNumberID
| Name/Typ | min..max | Definition |
|---|---|---|
TelephoneNumberID xs:string |
1..1 |
Zeichenkette, die einem "strengen" Muster für Telefonnummern entspricht, insbesondere keinerlei Trennzeichen enthält. |
Token64
| Name/Typ | min..max | Definition |
|---|---|---|
Token64 xs:token |
1..1 |
Zeichenkette, die aus maximal 64 und aus mindestens 1 Zeichen besteht, und die weder Carriage Return (#xD), Line Feed (#xA) noch Tabulatur (#x9) enthält, nicht mit einem Leerzeichen beginnt oder endet, und nicht zwei oder mehr unmittelbar aufeinander folgende Leerzeichen enthält. |
UUIDIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
UUIDIdentifier xs:string |
1..1 |
Universally Unique Identifier (ID, die dem Muster der kanonischen Darstellung von Universally Unique Identifier (UUID) entspricht). |
VersionIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
VersionIdentifier xs:token |
1..1 |
Versionsangabe.Die Versionsangabe besteht aus maximal 64 Zeichen. Sie besteht aus den folgenden Teilen: "Major Version"-Angabe, gefolgt von einem Punkt (#x2E), gefolgt von der "Minor Version"-Angabe. Sowohl "Major Version" als auch "Minor Version" bestehen ausschließlich aus Ziffern. "Minor Version" besteht aus genau 2 Ziffern. |
Messaging-Webservice: Definitionen von Messages
MasterMessageEnvelope
“Umschlag” zu einer Message, bestehend aus “aufgezählten” bzw. referenzierten Objekten, z.B. Angaben zu Unternehmen, und den eigentlichen Inhalten.
| Name/Typ | min..max | Definition |
|---|---|---|
ListedData |
0..1 |
Aufzählung von “Objekten”, auf die im Message-Inhalt (MessageData-Element) verwiesen wird, z.B. nicht-natürliche Personen oder Standorte.Anmerkung: Solche “Objekte” können auch aus vorangegangenen bzw. übergeordneten Messages stammen, z.B. Angaben zu einer Bestellung. Anstelle der Wiederholung dieser Daten in jeder Message ist lediglich eine Bezugnahme mittels grundlegender Angaben, insbesondere IDs, vorgesehen. |
MessageData |
0..1 |
Message-Inhalt. |
ActualWaypointEvent
Angaben zu einer absolvierten Station eines Transports.
| Name/Typ | min..max | Definition |
|---|---|---|
DateTime |
0..1 |
Zeitpunkt, an dem die Station absolviert wurde, d.h. das Transportmittel den Standort verlässt, z.B. Transportbeginndatum oder Enddatum. |
SiteLocalUnitReferenceID |
0..1 |
Bezug auf den Standort, der Station des Transports ist (Bezug auf einen Eintrag aus ListedData/LocalUnit). |
PartyReferenceID |
0..1 |
Bezug auf das Unternehmen bzw. die Person, die vor Ort Abholung bzw. Entgegennahme abwickelt (Bezug auf einen Eintrag aus ListedData/Organization oder ListedData/Person). |
Address
Angaben zu einer Adresse.
| Name/Typ | min..max | Definition |
|---|---|---|
Component |
1..* |
Adresskomponenten, z.B. Straße, Postleitzahl, und dergleichen. Es sollen genau die für die Zielangabe benötigten Adresskomponenten angegeben sein. Weder sollen benötigte Adresskomponenten fehlen - z.B. werden Angaben zu Örtlichkeit und Postleitzahl fast immer benötigt - noch soll eine Ergänzung um nicht benötigte Angaben erfolgen - z.B. wird die Angabe von Verwaltungseinheiten wie Bundesland oder Bezirk fast nie benötigt. |
AddressComponent
Angaben zu einer Adresskomponente, z.B. Straße oder Postleitzahl. Zu einer Adresskomponente wird entweder eine Identifikation (RepresentationID, z.B. Hausnummer), oder ein Auszeichnungstext (z.B. RepresentationDesignation, z.B. Straßenname) angegeben.
| Name/Typ | min..max | Definition |
|---|---|---|
TypeID |
1..1 |
Identifikation des Adresskomponententyps, z.B. Straße oder Ort (Codeliste 6856). |
ID |
0..1 |
Identifikation einer Adresskomponente des angegebenen Typs, z.B. ISO-Code “040” zur Identifikation des Landes Österreich.Anmerkung: Ausschließlich für Identifikationen vorgesehen, die NICHT als Teil von korrekten Adressrepräsentationen, etwa Anschriften auf Briefen, aufscheinen. Postleitzahlen, Hausnummern oder Türnummern hingegen, die sehr wohl in der jeweiligen korrekten Adressrepräsentationen aufscheinen, werden unter “RepresentationID” angegeben. |
RepresentationID |
0..1 |
Identifikation einer Adresskomponente des angegebenen Typs, z.B. “6714” in Zusammenhang mit Typ “Postgebiet (Postleitzahl)”.Anmerkung: Ausschließlich für Identifikationszeichenketten vorgesehen, die als Teil von korrekten Adressrepräsentationen, etwa Anschriften auf Briefen, aufscheinen, z.B. Postleitzahlen, Hausnummern oder Türnummern. Andere Identifikationen von Adresskomponenten, solche die nicht als Teil von korrekten Adressrepräsentationen aufscheinen, z.B. ISO-Ländercodes, werden unter “ID” angegeben. |
RepresentationDesignation |
0..1 |
Bezeichnung der Adresskomponente, z.B. für eine Adresskomponente vom Typ “Straße” der Straßenname, etwa “Wiedner Hauptstraße”. |
AssignmentMultiPartIdentifier
Identifikation eines Grundstücks per Katastralgemeindenummer und Grundstücksnummer.
| Name/Typ | min..max | Definition |
|---|---|---|
PartIdentifier |
2..2 |
Katastralgemeindenummer und Grundstücksnummer (in dieser Reihenfolge). |
CommunicationNetworkEndpoint
Angaben zu einer Telefonnummer, Faxnummer, E-Mail-Adresse oder Website-Adresse, allgemein “Kommunikationsnetzwerkendpunkt”.
| Name/Typ | min..max | Definition |
|---|---|---|
TypeID |
1..1 |
Identifikation der Art des Endpunkts eines Kommunikationsnetzwerks, z.B. E-Mail-Account, Website oder Telefonanschluss (Codeliste 6745). |
ID |
1..1 |
Identifikation des Endpunkts eines Kommunikationsnetzwerks, z.B. E-Mail-Adresse, Website-Adresse (URL) oder Telefonnummer. |
Contact
Angaben zu einem Kontakt, z.B. einer Kontaktperson.
| Name/Typ | min..max | Definition |
|---|---|---|
PersonName |
0..1 |
Name einer Kontaktperson. |
CommunicationNetworkEndpoint |
0..4 |
Telefonnummer, Faxnummer, E-Mail-Adresse oder Website-Adresse, allgemein “Kommunikationsnetzwerkendpunkte”. |
DangerousGoodsDescription
Gefahrstoffbeschreibung und Sicherheitshinweise.
| Name/Typ | min..max | Definition |
|---|---|---|
Description |
1..16 |
Gefahrgut-Beschreibungszeile gemäß Gefahrgutvorschriften wie ADR (z.B. gemäß ADR 2017 Abschnitt 5.4.1.).Beispiel: “UN 1098 ALLYLALKOHOL, 6.1 (3), I, (C/D)”.Anmerkung 1: Handelt es sich um eine Gefahrgut-Beschreibungszeile gemäß ADR 2017, dann sind in dieser Beschreibungszeile die Buchstaben a (UN-Nummer), b (Offizielle Benennung), c (Gefahrzettelmuster), d (Verpackungsgruppe) und k (Tunnelcode) abgebildet, sowie allfällige weiteren Kennzeichnungen gemäß den Unterabschnitten zu 5.4.1, z.B. Kennzeichnung als Abfall gemäß Abschnitt 5.4.1.1.3.Anmerkung 2: Werden Gefahrgut-Beschreibungszeilen in mehreren Sprachen angegeben, dann wird erwartet, dass in IndividualDescription die unterschiedlichen Sprachvarianten derselben Beschreibungszeile angegeben sind. Ein Verteilen der unterschiedlichen Sprachvarianten auf verschiedene Description-Einträge ist hingegen nicht zulässig. Die Sprachvarianten haben für alle Zeilen dieselben zu sein. So ist es beispielsweise unzulässig, eine Zeile nur auf Deutsch anzugeben, wenn eine andere auf Deutsch und Englisch angegeben ist. Ebenso hat die Reihenfolge der Sprachen für alle Beschreibungszeilen dieselbe zu sein. |
Dimension
Angaben zu Abmessungen.
| Name/Typ | min..max | Definition |
|---|---|---|
WidthMeasure |
1..1 |
Breite (Abstand zwischen linker und rechter Seite) (Größeneinheit: Codeliste 3622). |
DepthMeasure |
1..1 |
Tiefe (Abstand zwischen Vorderseite und Rückseite) (Größeneinheit: Codeliste 3622). |
HeightMeasure |
1..1 |
Höhe (vertikale Abmessung, Abstand zwischen Unterseite und Oberseite) (Größeneinheit: Codeliste 3622). |
LocalUnitMeta
Grundlegende Ortsangaben (Angaben zu einer örtlichen Einheit), z.B. zu einem Standort bzw. einer Betriebsstätte.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
1..1 |
In der XML-Dateninstanz verwendeter ("technischer") Identifikator für den Standort oder die Anlage. |
ID |
0..8 |
Dem Standort bzw. der Anlage zugewiesene Identifikatoren, jeweils zusammen mit der Identifikation der Sammlung von Identifikatoren (Auswahl eines Eintrags aus Codeliste 9776).Beispiel: GLN, die im EDM zur Identifikation des Standorts verwendet wird (zusammen mit GTIN “9008390104026” für “EDM”). |
PredeterminedScopeAssignmentID |
0..1 |
Vom initialen Ersteller der Angaben zum Standort oder zur Anlage zugewiesene ID.Anmerkung: Eindeutigkeit wird bei dieser ID nur in einem engen Rahmen erwartet, z.B. nur innerhalb der vom jeweiligen Beteiligten vergebenen IDs (bei von unterschiedlichen Beteiligten zugewiesenen IDs kann es zu Konflikten kommen). |
MultiPartID |
0..* |
Mehrteilige Identifikatoren zum Standort oder der Anlage (Identifikationsschema: Codeliste 5951).Anmerkung 1: Diese mehrteiligen Identifikatoren werden im vorliegenden Datenformat ausschließlich zur Identifikation von Grundstücken verwendet, auf welchen sich der Standort bzw. die Anlage befinden, d.h. für zweiteilige Kombinationen aus Katastralgemeindenummer und Grundstücksnummer.Anmerkung 2: Die Identifikation von Grundstücken ist als “Ausweichvariante” für Fälle vorgesehen, in welchen weder Punkt-Geodaten noch Adressen bereitgestellt werden können. |
Name |
0..1 |
Bezeichnung des Standorts oder der Anlage. |
TypeID |
1..1 |
Art der örtlichen Einheit (Standort, ortsfeste Anlage oder mobile Anlage, Codeliste 9351).Anmerkung 1: Die Angabe von Anlagen ist nur für den Fall vorgesehen, dass ein Bezug auf den Anlagenregister-Eintrag des EDM mit angegeben wird (d.h. unter “ID” eine EDM-Anlagen-GLN angegeben wird). Andernfalls wird ausschließlich der Standort angegeben. Für im EDM registrierte Standorte wird unter “ID” ebenfalls die GLN des Standort-Eintrags im EDM erwartet. Beim Absendeort kann es sich aber beispielsweise auch um einen nicht im EDM registrierten Standort handeln. In diesem Fall wird als "Art der örtlichen Einheit" der Wert "Standort" erwartet, die “ID”-Angabe entfällt.Anmerkung 2: Für mobile Anlagen werden an dieser Stelle keine Ortsbezüge (z.B. Koordinaten, Adressen, Grundstücksnummern) erwartet. Mobile Anlagen können nicht für sich allein als Ortsbezug angegeben werden (z.B. als Absendeort), sondern nur in Kombination mit einem Bezug auf einen Standort oder eine ortsfeste Anlage (den Aufstellungsort der mobilen Anlage). |
Description |
0..1 |
Anmerkungen zum Standort bzw. zur Anlage, oder im Falle von Baustellen Beschreibung der Baustelle. |
Address |
0..1 |
Adresse des Standorts oder der Anlage. |
gml:Pointgml:Point |
0..1 |
Punkt-Geodaten zum Standort bzw. der Anlage im GML-Point-Format.Anmerkung 1: Es wird die Angabe des Flächenmittelpunkts des Standorts bzw. der Anlage erwartet.Anmerkung 2: Das vorliegende Datenformat unterstützt nur einen Auszug aller gemäß GML-Standard möglichen Point-Angaben. Der unterstützte Auszug ist mit einer von GML abgeleiteten, eigens definierten XSD-Datei vorgegeben.Anmerkung 3: Es wird die Angabe des räumlichen Bezugssystems erwartet (Attribut srsName). Der (jeweilige) Wert hat mit der Zeichenkette “urn:ogc:def:crs:” zu beginnen, und auch darüber hinaus dem OGC URN-Muster für räumliche Bezugssysteme zu entsprechen, z.B. “urn:ogc:def:crs:EPSG::3225”. Die zulässigen räumlichen Bezugssysteme sind in Codeliste 8390 definiert. Im Allgemeinen wird, wenn möglich, die Bereitstellung von “Originaldaten” erwartet, d.h. ohne Umrechnungen zwischen räumlichen Bezugssystemen. |
LogisticUnitObject
Angaben zu einer Logistikeinheit.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
0..1 |
In der Dateninstanz verwendeter Identifikator für die Logistikeinheit. |
UUID |
1..1 |
Beim initialen Erstellen der elektronischen Logistikeinheits-Dateninstanz automatisch zugewiesene UUID (Universally Unique Identifier). |
ID |
0..8 |
Identifikatoren, die der Logistikeinheit zugewiesen sind (collectionID aus Codeliste 7300). |
Package |
0..1 |
Art des Behältnisses bzw. der Verpackung der Logistikeinheit, z.B. Fass (Codeliste 3863). |
Description |
0..1 |
Beschreibung der Logistikeinheit. |
GrossPropertyStatement |
0..1 |
Masse der Logistikeinheit inkl. Behältnissen bzw. Verpackung (so vorhanden), sowie gegebenenfalls andere Größen wie Volumen. |
NetPropertyStatement |
0..1 |
Masse der Logistikeinheit ohne Behältnissen bzw. Verpackung (z.B. Masse des Abfalls), sowie gegebenenfalls andere Größen wie Volumen oder Trockenmasse. |
Dimension |
0..1 |
Abmessungen der Logistikeinheit. |
MasterMessageData
Inhalte einer Message.
| Name/Typ | min..max | Definition |
|---|---|---|
Shipment |
0..* |
Lieferungen und damit verbundene Dienstleistungen. |
TransportMovement |
0..* |
Einzelne Transporte. |
MessageListedData
Aufzählung von “Objekten”, z.B. Personen, mit deren Angaben.Anmerkung: Innerhalb des Dokuments kann auf aufgezählte “Objekte” mit einer ID verwiesen werden. Dadurch unterstützt das Datenformat die Vermeidung von Redundanz: Detailangaben zu einem “Objekt” brauchen nur einmal enthalten zu sein, auch dann wenn mehrfach auf das “Objekt” Bezug genommen wird, z.B. wenn mehrfach auf dasselbe Unternehmen Bezug genommen wird.
| Name/Typ | min..max | Definition |
|---|---|---|
Person |
0..* |
Liste von Personen (Bezug/allgemeine Angaben).Anmerkung: An anderen Stellen im Dokument erfolgen Personenangaben mittels dokumentinterner Verweise auf Einträge der Personen-Liste. |
Organization |
0..* |
Liste von Organisationen (“nicht-natürlichen Personen”) (Bezug/allgemeine Angaben).Anmerkung: An anderen Stellen im Dokument erfolgen Organisationsangaben mittels dokumentinterner Verweise auf Einträge der Organisations-Liste. |
LocalUnit |
0..* |
Liste von örtlichen Einheiten, z.B. Standorten oder Anlagen, an denen Abholungen erfolgen (Bezug/allgemeine Angaben).Anmerkung 1: An anderen Stellen im Dokument erfolgen Angaben zu örtlichen Einheiten mittels dokumentinterner Verweise auf Einträge der Liste örtlicher Einheiten.Anmerkung 2: Eine genaue Beschreibung, was unter “örtlichen Einheiten” verstanden wird, ist bei der “LocalUnit”-Struktur zu finden. |
Shipment |
0..* |
Liste von Lieferungen (Bezug/allgemeine Angaben). |
MultilingualDescription
Beschreibungstext.Anmerkung: Es werden Beschreibungstexte in verschiedenen Sprachen unterstützt. Dies wird im vorliegenden Datenformat insbesondere in Zusammenhang mit Gefahrgutbeschreibungen genutzt, um Gefahrgutbeschreibungen in unterschiedlichen Sprachen, z.B. auch Englisch, zu ermöglichen.
| Name/Typ | min..max | Definition |
|---|---|---|
IndividualDescription |
1..4 |
Beschreibungstext, mit ausgewiesener Sprache. |
MultilingualDescriptionConstrained
Beschreibungstext.Anmerkung: Im vorliegenden Datenformat werden an den meisten Stellen Beschreibungstexte in deutscher Sprache erwartet. Die vom “MultilingualDescription”-Typ grundsätzlich unterstützte Möglichkeit, Angaben in mehreren verschiedenen Sprachen zu ermöglichen, wird an diesen Stellen nicht genutzt: “IndividualDescription” ist deshalb hier nicht wiederholbar.
| Name/Typ | min..max | Definition |
|---|---|---|
IndividualDescription |
1..1 |
Beschreibungstext, mit ausgewiesener Sprache (Deutsch). |
MultilingualDesignationConstrained
Bezeichnungstext.Anmerkung: Im vorliegenden Datenformat werden an den meisten Stellen Bezeichnungstexte in deutscher Sprache erwartet. Die vom “MultilingualDesignation”-Typ grundsätzlich unterstützte Möglichkeit, Angaben in mehreren verschiedenen Sprachen zu ermöglichen, wird an diesen Stellen nicht genutzt: “IndividualDesignation” ist deshalb hier nicht wiederholbar.
| Name/Typ | min..max | Definition |
|---|---|---|
IndividualDesignation |
1..1 |
Kennungstext in individuellen Sprachen. |
SiteServiceEvent
Angaben zu einer im Zuge einer Lieferung am Abholort erfolgenden Dienstleistung.
| Name/Typ | min..max | Definition |
|---|---|---|
Period |
0..1 |
Zeitraum, in dem das Ereignis stattfindet. |
Description |
0..1 |
Beschreibung der Dienstleistung am Abholort. |
Contact |
0..1 |
Vor-Ort-Kontakt für den Erbringer der Dienstleistung. |
SiteLocalUnitReferenceID |
0..1 |
Bezug auf den Standort, an dem die Abholung erfolgt (Bezug auf einen Eintrag aus ListedData/LocalUnit). |
StationaryInstallationLocalUnitReferenceID |
0..1 |
Bezug auf die ortsfeste Anlage, an der die Abholung erfolgt (Bezug auf einen Eintrag aus ListedData/LocalUnit). |
MobileInstallationLocalUnitReferenceID |
0..1 |
Bezug auf die mobile Anlage, an der die Abholung erfolgt (Bezug auf einen Eintrag aus ListedData/LocalUnit). |
PartyReferenceID |
0..1 |
Bezug auf das Unternehmen bzw. die Person, die vor Ort die Abholung abwickelt (Bezug auf einen Eintrag aus ListedData/Organization oder ListedData/Person).Anmerkung: Dabei kann es sich um den Übergeber (im rechtlichen Sinn) handeln, es kann sich aber auch um davon abweichende Unternehmen handeln. |
OrganizationMeta
Grundlegende Angaben zu einer Organisation, z.B. zu einer juristischen Person.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
1..1 |
In der XML-Dateninstanz verwendeter ("technischer") Identifikator für das Unternehmen bzw. die nicht-natürliche Person. |
ID |
0..8 |
Dem Unternehmen bzw. der nicht-natürlichen Person zugewiesene Identifikatoren, jeweils zusammen mit der Identifikation der Sammlung von Identifikatoren (Auswahl eines Eintrags aus Codeliste 8131).Beispiel: GLN (Global Location Number), die der nicht-natürlichen Person im EDM zugewiesen ist (zusammen mit GTIN “9008390104026” für “EDM”).Anmerkung: Es wird empfohlen, zu sämtlichen nicht-natürlichen Personen die GLN mit anzuführen, mit der die betreffende Person im EDM registriert ist. |
Name |
0..1 |
Bezeichnung des Unternehmens bzw. der nicht-natürlichen Person. |
Address |
0..1 |
Sitzadresse des Unternehmens bzw. der nicht-natürlichen Person. |
PackageCollectionObject
Angaben zu einem oder mehreren Packstücken desselben Behältnistyps bzw. Verpackungstyps.
| Name/Typ | min..max | Definition |
|---|---|---|
PackageTypeID |
0..1 |
Art des Behältnisses bzw. der Verpackung, z.B. Fass (Codeliste 3863). |
PackageTypeDesignation |
0..1 |
Art des Behältnisses bzw. der Verpackung, z.B. Fass.Anmerkung: Die textuelle Angabe der Art der Verpackung ist für solche Verpackungsarten vorgesehen, für die kein passender Codelisteneintrag existiert. |
TotalQuantity |
1..1 |
Gesamtzahl der Packstücke des angegebenen Typs. |
Period
Angaben zu einem Zeitraum.
| Name/Typ | min..max | Definition |
|---|---|---|
StartDate |
1..1 |
Beginndatum (erster Tag des Zeitraums). |
EndDate |
1..1 |
Enddatum (letzter Tag des Zeitraums). |
StartTime |
0..1 |
Beginn-Uhrzeit. |
EndTime |
0..1 |
End-Uhrzeit. |
PersonMeta
Grundlegende Angaben zu einer Person, z.B. Vorname, Nachname und Geburtsdatum.Anmerkung: Solche Angaben zu natürlichen Personen werden in Dateninstanzen dieses Datenformats etwa dann benötigt, wenn Angaben zu einem Entsorgungsauftrag ausgetauscht werden, der von einer natürlichen Person stammt.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
1..1 |
In der XML-Dateninstanz verwendeter ("technischer") Identifikator für die Person. |
ID |
0..1 |
Der natürlichen Person zugewiesene Identifikatoren, jeweils zusammen mit der Identifikation der Sammlung von Identifikatoren (Auswahl eines Eintrags aus Codeliste 1756). Beispiel: GLN (Global Location Number), die der Person im EDM zugewiesen ist (zusammen mit GTIN “9008390104026” für “EDM”).Anmerkung: Im vorliegenden Datenformat ist für natürliche Personen ausschließlich die Angabe von GLNs vorgesehen bzw. möglich, mit welchen diese Personen im EDM registriert sind. Die Angabe anderer Identifikationsnummern ist hingegen nicht vorgesehen. |
GivenName |
0..1 |
Vorname. |
FamilyName |
0..1 |
Nachname. |
GenderID |
0..1 |
Geschlecht (Codeliste 4287). |
Address |
0..1 |
Anschrift der Person (typischerweise Adresse des Hauptwohnsitzes). |
PlannedWaypointEvent
Angaben zu einer geplanten Station eines Transports.
| Name/Typ | min..max | Definition |
|---|---|---|
Period <<>> |
0..1 |
Zeitraum, in dem sich das Transportmittel am Standort befindet.Anmerkung: Das Enddatum muss mit dem Beginndatum übereinstimmen, d.h. der Transport muss für einen konkreten Tag angekündigt sein. Diese Vorgabe ist auch per XSD-assert im XML Schema enthalten. Aus Gründen der Einheitlichkeit und der Übereinstimmung mit GS1 XML kommt an dieser Stelle dennoch die Period-Struktur zum Einsatz. |
SiteLocalUnitReferenceID |
0..1 |
Bezug auf den Standort, der Station des Transports ist (Bezug auf einen Eintrag aus ListedData/LocalUnit). |
PartyReferenceID |
0..1 |
Bezug auf das Unternehmen bzw. die Person, die vor Ort Abholung bzw. Entgegennahme abwickelt (Bezug auf einen Eintrag aus ListedData/Organization oder ListedData/Person). |
LoadingWaypoint |
1..1 |
Angabe ob es sich um eine Be- oder Entladung handelt. |
TransshipmentWaypoint |
0..1 |
Angabe ob es sich um eine Umladung handelt. |
InitialSiteLocalUnitReferenceID |
0..1 |
Bezug auf den Standort, der die erste bzw. letzte Statition des Transports ist (Bezug auf einen Eintrag aus ListedData/LocalUnit). Nur relevant für Umladewegpunkte (TransshipmentWaypoint=true), da der Wert ansonsten mit SiteLocalUnitReferenceID gleich ist. |
InitialPartyReferenceID |
0..1 |
Bezug auf das Unternehmen bzw. die Person, die die erste Abholung bzw. letzte Entgegennahme abwickelt (Bezug auf einen Eintrag aus ListedData/Organization oder ListedData/Person). Nur relevant für Umladewegpunkte (TransshipmentWaypoint=true), da der Wert ansonsten mit PartyReferenceID gleich ist. |
PropertyStatement
Aussage über eine Eigenschaft, z.B. Masse oder Volumen.
| Name/Typ | min..max | Definition |
|---|---|---|
PropertyKindID |
1..1 |
Identifikation einer Eigenschaftsart aus einer Codeliste von Eigenschaftsarten, z.B. Masse oder Volumen.Anmerkung: Aus welcher Codeliste von Eigenschaftsarten die Eigenschaftsart stammen muss, hängt vom Kontext ab, in dem PropertyStatement verwendet wird, und ist dort beschrieben. |
ValueAssignmentStatement |
1..1 |
Eine Wertzuweisungs-Aussage, z.B. “hat 200kg”. |
QuantificationTypeID |
0..1 |
Identifikation der Bestimmungsart (gemessen, gerechnet, geschätzt; Codeliste 7299). |
MethodID |
0..1 |
Identifikation einer Methode, die zur Bestimmung der Eigenschaft angewandt wurde.Anmerkung: Dieses Element ist für eine künftige Verwendung vorgesehen. Gemäß aktueller Datenformat-Spezifikation ist dieses Element nicht zu verwenden. |
MethodDescription |
0..1 |
Bezeichnung und/oder Beschreibung der Methode, mit welcher die Eigenschaft bestimmt wurde. |
ShipmentEvent
Angaben zu einer Lieferung.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
0..1 |
In der Dateninstanz verwendeter Identifikator für die Lieferung. |
UUID |
0..1 |
Beim initialen Erstellen der elektronischen Lieferungs-Dateninstanz automatisch zugewiesene UUID (Universally Unique Identifier).Anmerkung: Die UUID dient eindeutiger Zuordenbarkeit in der maschinellen Verarbeitung. Menschen brauchen mit UUIDs nicht notwendigerweise konfrontiert zu werden (in Benutzeroberflächen, Ausdrucken, usw.). Eine für Menschen einfacher handhabbare, und in Benutzeroberflächen, usw. jedenfalls zu verwendende ID ist in PredeterminedScopeAssignmentID vorgesehen. |
PredeterminedScopeAssignmentID |
0..1 |
Vom initialen Ersteller der Angaben zur Lieferung zugewiesene ID.Anmerkung 1: Es ist hierbei die Haupt-ID gemeint, die für Menschen die eindeutige Erkennbarkeit gewährleistet, und somit jedenfalls in Benutzeroberflächen, Ausdrucken, usw. mit angegeben sein soll.Anmerkung 2: Eindeutigkeit wird bei dieser ID nur in einem engen Rahmen erwartet, z.B. nur innerhalb der vom jeweiligen Beteiligten vergebenen IDs (bei von unterschiedlichen Beteiligten zugewiesenen IDs kann es zu Konflikten kommen), und innerhalb eines zeitlichen Rahmens von ungefähr einem Jahr (über mehrere Jahre Hinweg kann es zu ID-Konflikten kommen). |
ID |
0..8 |
Identifikatoren, die der Lieferung zugewiesen sind (collectionID aus Codeliste 7725). |
Designation |
0..1 |
Bezeichnungstext zur Lieferung. |
Description |
0..1 |
Beschreibung der Lieferung. |
ShipmentItem |
0..* |
Zur Lieferung gehörende Lieferungseinheiten. |
Package |
0..* |
Angaben zu Art der Behältnisse bzw. Verpackungen und Anzahl der zu dieser Lieferung gehörenden Packstücke. |
PickUpSiteService |
0..1 |
Angaben zur Abholung der Lieferung. |
DropOffSiteService |
0..1 |
Angaben zur Zustellung der Lieferung. |
HandOverPartyReferenceID |
0..1 |
Bezug auf den Übergeber der Lieferung (Bezug auf einen Eintrag aus ListedData/Party). Anmerkung 1: Entspricht “Shipper” in GS1 XML.Anmerkung 2: Kann als Teil von Begleit- bzw. Beförderungsdokumenten gemäß Gefahrgutvorschriften wie ADR (Buchstabe g gemäß ADR 2017 Abschnitt 5.4.1.1.1) und RID relevant sein - siehe auch DangerousGoods-Element. |
IntermediatePartyReferenceID |
0..* |
Angaben zu Streckengeschäftspartner. Anmerkung 1: Die Reihenfolge ist relevant. |
TakeOverPartyReferenceID |
0..1 |
Bezug auf den Übernehmer der Lieferung (Bezug auf einen Eintrag aus ListedData/Party).Anmerkung 1: Entspricht “Receiver” in GS1 XML.Anmerkung 2: Kann als Teil von Begleit- bzw. Beförderungsdokumenten gemäß Gefahrgutvorschriften wie ADR (Buchstabe g gemäß ADR 2017 Abschnitt 5.4.1.1.1) und RID relevant sein - siehe auch DangerousGoods-Element. |
RejectionReasonID |
0..1 |
Grund für die Ablehnung der Übergabe bzw. Übernahme (Codeliste 3161). |
LastResponseDateTime |
0..1 |
Frist (Datum und Uhrzeit) für Rückmeldung zur Teilnahme am Streckengeschäft. |
ShipmentEventMeta
Grundlegende Angaben zu einer Lieferung.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
1..1 |
In der Dateninstanz verwendeter Identifikator für die Lieferung. |
UUID |
1..1 |
Beim initialen Erstellen der elektronischen Lieferungs-Dateninstanz automatisch zugewiesene UUID (Universally Unique Identifier).Anmerkung: Die UUID dient eindeutiger Zuordenbarkeit in der maschinellen Verarbeitung. Menschen brauchen mit UUIDs nicht notwendigerweise konfrontiert zu werden (in Benutzeroberflächen, Ausdrucken, usw.). Eine für Menschen einfacher handhabbare, und in Benutzeroberflächen, usw. jedenfalls zu verwendende ID ist in PredeterminedScopeAssignmentID vorgesehen. |
PredeterminedScopeAssignmentID |
0..1 |
Vom initialen Ersteller der Angaben zur Lieferung zugewiesene ID.Anmerkung 1: Es ist hierbei die Haupt-ID gemeint, die für Menschen die eindeutige Erkennbarkeit gewährleistet, und somit jedenfalls in Benutzeroberflächen, Ausdrucken, usw. mit angegeben sein soll.Anmerkung 2: Eindeutigkeit wird bei dieser ID nur in einem engen Rahmen erwartet, z.B. nur innerhalb der vom jeweiligen Beteiligten vergebenen IDs (bei von unterschiedlichen Beteiligten zugewiesenen IDs kann es zu Konflikten kommen), und innerhalb eines zeitlichen Rahmens von ungefähr einem Jahr (über mehrere Jahre Hinweg kann es zu ID-Konflikten kommen). |
Designation |
0..1 |
Bezeichnungstext zur Lieferung. |
ShipmentItem |
0..* |
Grundlegende Angaben zu Lieferungseinheiten, die zu dieser Lieferung gehören. |
ShipmentItemMeta
Grundlegende Angaben zu einer Lieferungseinheit.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
1..1 |
In der Dateninstanz verwendeter Identifikator für die Lieferungseinheit. |
UUID |
1..1 |
Beim initialen Erstellen der elektronischen Lieferungseinheit-Dateninstanz automatisch zugewiesene UUID (Universally Unique Identifier).Anmerkung: Die UUID dient eindeutiger Zuordenbarkeit in der maschinellen Verarbeitung. Menschen brauchen mit UUIDs nicht notwendigerweise konfrontiert zu werden (in Benutzeroberflächen, Ausdrucken, usw.). Eine für Menschen einfacher handhabbare, und in Benutzeroberflächen, usw. jedenfalls zu verwendende ID ist in PredeterminedScopeAssignmentID vorgesehen. |
PredeterminedScopeAssignmentID |
0..1 |
Vom initialen Ersteller der Angaben zur Lieferungseinheit zugewiesene ID.Anmerkung 1: Es ist hierbei die Haupt-ID gemeint, die für Menschen die eindeutige Erkennbarkeit gewährleistet, und somit jedenfalls in Benutzeroberflächen, Ausdrucken, usw. mit angegeben sein soll.Anmerkung 2: Eindeutigkeit wird bei dieser ID nur in einem engen Rahmen erwartet, z.B. nur innerhalb der vom jeweiligen Beteiligten vergebenen IDs (bei von unterschiedlichen Beteiligten zugewiesenen IDs kann es zu Konflikten kommen), und innerhalb eines zeitlichen Rahmens von ungefähr einem Jahr (über mehrere Jahre Hinweg kann es zu ID-Konflikten kommen). |
Designation |
0..1 |
Bezeichnungstext zur Lieferungseinheit. |
ShipmentItemObject
Angaben zu einer Lieferungseinheit.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
0..1 |
In der Dateninstanz verwendeter Identifikator für die Lieferungseinheit. |
UUID |
0..1 |
Beim initialen Erstellen der elektronischen Lieferungseinheit-Dateninstanz automatisch zugewiesene UUID (Universally Unique Identifier). |
LineItemNumber |
0..1 |
Die Nummer der Lieferungseinheit innerhalb der Lieferung (1, 2, …). |
PredeterminedScopeAssignmentID |
0..1 |
Vom initialen Ersteller der Angaben zur Lieferungseinheit zugewiesene ID.Anmerkung 1: Es ist hierbei die Haupt-ID gemeint, die für Menschen die eindeutige Erkennbarkeit gewährleistet, und somit jedenfalls in Benutzeroberflächen, Ausdrucken, usw. mit angegeben sein soll.Anmerkung 2: Eindeutigkeit wird bei dieser ID nur in einem engen Rahmen erwartet, z.B. nur innerhalb der vom jeweiligen Beteiligten vergebenen IDs (bei von unterschiedlichen Beteiligten zugewiesenen IDs kann es zu Konflikten kommen), und innerhalb eines zeitlichen Rahmens von ungefähr einem Jahr (über mehrere Jahre Hinweg kann es zu ID-Konflikten kommen). |
WasteTypeID |
0..1 |
Art des Abfalls.Unterstützte Klassifikationen:1. Österreichische Abfallverzeichnisverordnung (Anlage 5) (collectionID: 5174; Inhalt: Code aus Codeliste 5174); |
WasteContaminationTypeID |
0..* |
Kontaminationen des Abfalls (zutreffende Kontaminationsgruppen) (Codeliste 7835). |
Description |
0..1 |
Beschreibung der Lieferungseinheit. |
Package |
0..1 |
Angaben zu Art der Behältnisse bzw. Verpackungen und Anzahl der zu dieser Lieferungseinheit gehörenden Packstücke.Anmerkung: Art und Anzahl der Behältnisse (Bruttomasse) ist auch als Teil von Begleit- bzw. Beförderungs-Dokumenten gemäß Gefahrgutvorschriften wie ADR (Buchstabe e gemäß ADR 2017 Abschnitt 5.4.1.1.1) und RID relevant - siehe auch DangerousGoodsDescription-Element. |
GrossPropertyStatement |
0..1 |
Gesamtmasse der Lieferungseinheit inkl. Verpackungen (so vorhanden), sowie gegebenenfalls andere Größen wie Volumen (PropertyKindID: Eintrag aus Codeliste 4288. NumericValue/@unitID: Eintrag aus Codeliste 8575).Anmerkung: Die Gesamtmasse inkl. Behältnissen (Bruttomasse) ist auch als Teil von Begleit- bzw. Beförderungs-Dokumenten gemäß Gefahrgutvorschriften wie ADR (Buchstabe f gemäß ADR 2017 Abschnitt 5.4.1.1.1) und RID relevant - siehe auch DangerousGoodsDescription-Element. |
NetPropertyStatement |
0..1 |
Masse der Lieferungseinheit ohne Verpackungen (z.B. Masse des Abfalls), sowie gegebenenfalls andere Größen wie Volumen oder Trockenmasse (PropertyKindID: Eintrag aus Codeliste 9000. NumericValue/@unitID: Eintrag aus Codeliste 8575). Wenn eine VEBSV-ID (ConsignmentNoteReferenceID) angegeben ist, dann muss die PropertyKindId die ID für Masse sein und die unitId kg sein.Anmerkung: Masse bzw. Volumen sind auch als Teil von Begleit- bzw. Beförderungsdokumenten gemäß Gefahrgutvorschriften wie ADR (Buchstabe f gemäß ADR 2017 Abschnitt 5.4.1.1.1) und RID relevant - siehe auch DangerousGoodsDescription-Element. |
LogisticUnit |
0..1 |
Logistikeinheiten, die zur Lieferungseinheit gehören. |
ConsignmentNoteReferenceID |
0..1 |
“VEBSV-ID” (ID zum elektronischen Begleitscheinverfahren).Anmerkung: Über die sogenannte “VEBSV-ID” (Abfall-Übergabe/Übernahme- bzw. Beförderungs-ID) werden zusammengehörige Angaben zu Abfall-Übergaben/Übernahmen und Abfalltransporten (vor und nach Übergabe/Übernahme bzw. Transport) miteinander in Verbindung gebracht. |
DangerousGoodsDescription |
0..1 |
Zur Lieferungseinheit gehörende Sicherheitshinweise für den Umgang mit Gefahrstoffen.Anmerkung: Ein Teil der für Begleit- bzw. Beförderungsdokumente gemäß Gefahrgutvorschriften wie ADR und RID relevanten Angaben, z.B. zu Absender, Empfänger, Masse bzw. Volumen, ist als gewöhnlicher Bestandteil der Beschreibung von Lieferungen vorgesehen (d.h. unabhängig davon, ob es sich um Gefahrgut handelt oder nicht). Im Datenformat werden diese Angaben daher in der Struktur zur Beschreibung von Gefahrgut bzw. Sicherheitshinweisen nicht wiederholt. |
ContainsPersistentOrganicPollutant |
0..1 |
PersistentOrganicPollutant (POP) Kennzeichen. |
TransportItemObject
Angaben zu Transportgut.
| Name/Typ | min..max | Definition |
|---|---|---|
ShipmentItemReferenceID |
0..1 |
Bezug auf die Lieferungseinheit, dem das Transportgut entspricht bzw. zu dem es gehört. |
ServiceTypeID |
0..1 |
Art der Dienstleistung (Code/Identifikationsnummer, die der Dienstleistungserbringer der Art von Dienstleistung, d.h. der Abfall/Transportgut-Abholung zugewiesen hat, z.B. Artikelnummer).Anmerkung: Transporte erfolgen im Allgemeinen im Einklang mit zuvor übermittelten Bestellungen. Die Art der Dienstleistung (Dienstleistungsnummer, Artikelnummer) ergibt sich daher im Allgemeinen aus der Bestellung, und braucht in den Angaben zum Transport nicht wiederholt zu werden. Bei Durchführung des Transports kann es jedoch auch passieren, dass Abweichungen zu einer zuvor übermittelten Bestellung festgestellt werden, z.B. dass es sich um eine andere Abfallart handelt. In diesem Fall sind für gewöhnlich korrigierte Bestellangaben auszutauschen. Mit dem ServiceTypeID-Element wird darüber hinaus ermöglicht, direkt in den Transportangaben eine “korrigierte” Dienstleistungs- bzw. Artikel-Nummer zu übermitteln. |
WasteTypeID |
0..1 |
Art des Abfalls.Unterstützte Klassifikationen:1. Österreichische Abfallverzeichnisverordnung (Anlage 5) (collectionID: 5174; Inhalt: Code aus Codeliste 5174); |
WasteContaminationTypeID |
0..* |
Kontaminationen des Abfalls (zutreffende Kontaminationsgruppen) (Codeliste 7835). |
Description |
0..1 |
Beschreibung des Transportguts. |
Package |
0..1 |
Angaben zu Art und Anzahl der Behältnisse bzw. Verpackungen. |
GrossPropertyStatement |
0..1 |
Gesamtmasse des Transportguts inkl. Behältnisse bzw. Verpackungen (so vorhanden), sowie gegebenenfalls andere Größen wie Volumen (PropertyKindID: Eintrag aus Codeliste 4288. NumericValue/@unitID: Eintrag aus Codeliste 8575). |
NetPropertyStatement |
0..1 |
Masse des Transportguts ohne Behältnisse bzw. Verpackungen (z.B. Masse des Abfalls), sowie gegebenenfalls andere Größen wie Volumen oder Trockenmasse (PropertyKindID: Eintrag aus Codeliste 9000. NumericValue/@unitID: Eintrag aus Codeliste 8575). Wenn eine VEBSV-ID (ConsignmentNoteReferenceID) angegeben ist, dann muss die PropertyKindId die ID für Masse sein und die unitId kg sein. |
ConsignmentNoteReferenceID |
0..1 |
“VEBSV-ID” (ID zum elektronischen Begleitscheinverfahren).Anmerkung: Über die sogenannte “VEBSV-ID” (Abfall-Übergabe/Übernahme bzw. Beförderungs-ID) werden zusammengehörige Angaben zu Abfall-Übergaben/Übernahmen und Abfalltransporten (vor und nach Übergabe/Übernahme bzw. Transport) miteinander in Verbindung gebracht. |
DangerousGoodsDescription |
0..1 |
Zum Transportgut gehörende Sicherheitshinweise für den Umgang mit Gefahrstoffen.Anmerkung 1: Ein Teil der für Begleit- bzw. Beförderungsdokumente gemäß Gefahrgutvorschriften wie ADR und RID relevanten Angaben, z.B. zu Absender, Empfänger, Masse bzw. Volumen, ist als gewöhnlicher Bestandteil der Beschreibung des Transportguts vorgesehen (d.h. unabhängig davon, ob es sich um Gefahrgut handelt oder nicht). Im Datenformat werden diese Angaben daher in der Struktur zur Beschreibung von Gefahrgut bzw. Sicherheitshinweisen nicht wiederholt.Anmerkung 2: In Angaben zu entladenem Transportgut werden im Allgemeinen keine Angaben zu Sicherheitshinweisen für den Umgang mit Gefahrstoffen benötigt. |
ContainsPersistentOrganicPollutant |
0..1 |
PersistentOrganicPollutant (POP) Kennzeichen. |
TransportMeansObject
Angaben zu einem Transportmittel, d.h. einem Gerät mit eigenem Motor bzw. Antrieb, das dazu dient, Güter oder andere Gegenstände zu transportieren, z.B. LKW, Zug (Lokomotive), Flugzeug oder Schiff.
| Name/Typ | min..max | Definition |
|---|---|---|
PredeterminedScopeAssignmentID |
0..1 |
ID, die dem Transportmittel zugewiesen ist, z.B. LKW-Kennzeichen. |
ModeID |
0..1 |
Art des Transports, der mit dem Transportmittel durchgeführt wird, z.B. Straße oder Schiene (Codeliste 2939). |
TransportMovementEvent
Angaben zu einem Transport, z.B. Transporteur und Art des Transportmittels.
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentID |
0..1 |
In der Dateninstanz verwendeter Identifikator für den Transport. |
UUID |
1..1 |
Beim initialen Erstellen der elektronischen Transport-Dateninstanz automatisch zugewiesene UUID (Universally Unique Identifier).Anmerkung: Die UUID dient eindeutiger Zuordenbarkeit in der maschinellen Verarbeitung. Menschen brauchen mit UUIDs nicht notwendigerweise konfrontiert zu werden (in Benutzeroberflächen, Ausdrucken, usw.). Eine für Menschen einfacher handhabbare, und in Benutzeroberflächen, usw. jedenfalls zu verwendende ID ist in PredeterminedScopeAssignmentID vorgesehen. |
PredeterminedScopeAssignmentID |
0..1 |
Vom initialen Ersteller der Angaben zum Transport zugewiesene ID.Anmerkung 1: Es ist hierbei die Haupt-ID gemeint, die für Menschen die eindeutige Erkennbarkeit gewährleistet, und somit jedenfalls in Benutzeroberflächen, Ausdrucken, usw. mit angegeben sein soll.Anmerkung 2: Eindeutigkeit wird bei dieser ID nur in einem engen Rahmen erwartet, z.B. nur innerhalb der vom jeweiligen Beteiligten vergebenen IDs (bei von unterschiedlichen Beteiligten zugewiesenen IDs kann es zu Konflikten kommen), und innerhalb eines zeitlichen Rahmens von ungefähr einem Jahr (über mehrere Jahre Hinweg kann es zu ID-Konflikten kommen). |
Designation |
0..1 |
Bezeichnungstext zum Transport. |
Description |
0..1 |
Anmerkungen zum Transport. |
Contact |
0..1 |
Kontaktangaben zum konkreten Transport. |
TransportMeans |
0..1 |
Angaben zum Transportmittel, mit dem der Transport durchgeführt wird. |
AbortReasonId |
0..1 |
Grund für den Transportabbruch (Codeliste 8723). |
ActualWaypointEvent |
0..1 |
Bereits absolvierte Stationen des Transports, z.B. zum Beladen und Entladen von Lieferungen oder zum Durchführen sonstiger Dienstleistungen. |
PlannedWaypointEvent |
0..2 |
Geplante Stationen des Transports, z.B. zum Beladen und Entladen von Lieferungen oder zum Durchführen sonstiger Dienstleistungen. |
TransportItem |
0..* |
Angaben zu einem Transportgut. |
CarrierPartyReferenceID |
0..1 |
Bezug auf den Transporteur (Eintrag aus ListedData/Organization). |
ValueAssignmentStatement
Eine Wertzuweisungs-Aussage, dh eine Aussage über das Annehmen von Werten, z.B. “hat 200kg”.
| Name/Typ | min..max | Definition |
|---|---|---|
NumericValue |
0..1 |
Als Zahl angegebener Wert, potentiell in Kombination mit einer Einheit, z.B. “200kg” (“200 Kilogramm”).Anmerkung: Die Einheit wird über den ISO/UCUM-Code identifiziert. |
Datentypen
AddressComponentDesignation
| Name/Typ | min..max | Definition |
|---|---|---|
AddressComponentDesignation Token120 |
1..1 |
Bezeichnung einer Adresskomponente, z.B. für eine Adresskomponente vom Typ “Straße” der Straßenname, etwa “Wiedner Hauptstraße”. |
AssignmentIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
AssignmentIdentifier |
1..1 |
Einem Objekt zugeordnete, in einem bestimmten Kontext eindeutige, und somit in diesem Kontext für die Objektidentifikation geeignete Zeichenkette. Z.B. eine zu einer Firma angegebene Firmenbuchnummer. Zusätzlich zu der das Objekt identifizierenden Zeichenkette wird eine Identifikation der Sammlung von IDs angegeben. |
collectionID SimpleToken |
1..1 |
Identifikation der Sammlung von Identifikatoren (z.B. Register oder Codeliste), der die angegebene Identifikationszeichenkette entstammt.Anmerkung 1: Wenn es sich bei der Sammlung von Identifikatoren um eine Codeliste handelt, dann wird die 4-stellige Codelisten-Nummer als Identifikation der Sammlung von Identifikatoren angegeben. Wenn es sich bei der Sammlung von Identifikatoren um ein Register handelt, dann wird diejenige ID (GTIN), die dem Register gemäß Codeliste zugewiesen ist, als Identifikation der Sammlung von Identifikatoren angegeben. Die Identifikation der Codeliste selbst kann und soll in diesem Fall nicht angegeben werden.Anmerkung 2: Welche Sammlungen von Identifikatoren zulässigerweise identifiziert werden können, hängt vom Kontext ab, in dem der Datentyp verwendet wird. |
collectionDesignation NormalizedString256 |
0..1 |
Bezeichnung der Sammlung, aus der die angegebene Identifikationszeichenkette stammt, z.B. “Firmenbuch”. |
Date
| Name/Typ | min..max | Definition |
|---|---|---|
Date xs:date |
1..1 |
Datum, d.h. Identifikation eines Tages. |
DateTime
| Name/Typ | min..max | Definition |
|---|---|---|
DateTime xs:dateTime |
1..1 |
Zeitpunkt. |
DecimalNonNegativeIntegerNumeral20Digits
| Name/Typ | min..max | Definition |
|---|---|---|
DecimalNonNegativeIntegerNumeral20Digits xs:nonNegativeInteger |
1..1 |
Wertebereich, zu dem alle dezimalen Numerale gehören, die aus maximal 20 Ziffern bestehen, und die nichtnegative ganze Zahlen repräsentieren. |
DecimalNumeral25Digits
| Name/Typ | min..max | Definition |
|---|---|---|
DecimalNumeral25Digits xs:decimal |
1..1 |
Wertebereich, zu dem alle dezimalen Numerale gehören, die aus insgesamt maximal 25 Ziffern bestehen, von denen maximal 5 Nachkommastellen sind. |
DecimalPositiveIntegerNumeral8Digits
| Name/Typ | min..max | Definition |
|---|---|---|
DecimalPositiveIntegerNumeral8Digits xs:positiveInteger |
1..1 |
Wertebereich, zu dem alle dezimalen Numerale gehören, die aus maximal 8 Ziffern bestehen, und die positive ganze Zahlen repräsentieren. |
Designation
| Name/Typ | min..max | Definition |
|---|---|---|
Designation |
1..1 |
Zeichenkette, z.B. Wort, Phrase, usw., die der Erkennung und Unterscheidung dient. Beispiele sind Straßennamen und Dokumenttitel. |
languageID SimpleToken |
0..1 |
Identifikation der Sprache, in der die Kennung angegeben ist (Codeliste 7632). Für Kennungen, die sprachunabhängig sind, z.B. Nummern, entfällt die Angabe der Sprache. |
Description
| Name/Typ | min..max | Definition |
|---|---|---|
Description |
1..1 |
Beschreibungstext. |
languageID SimpleToken |
1..1 |
Identifikation der Sprache, in der die Beschreibung angegeben ist (Codeliste 7632). |
DescriptionConstrained
| Name/Typ | min..max | Definition |
|---|---|---|
DescriptionConstrained |
1..1 |
Beschreibungstext in deutscher Sprache. |
languageID SimpleToken |
1..1 |
Identifikation der Sprache, in der die Beschreibung angegeben ist (Codeliste 7632). |
DocumentScopeAssignmentIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeAssignmentIdentifier xs:token |
1..1 |
In einem Objektkontext angegebener Wert (Identifikator), der innerhalb der Dateninstanz für etwaige Referenzierungen des Objekts verwendet wird.Anmerkung: Für Identifikatoren dieses Typs kann die Eindeutigkeit nur im Dateninstanzkontext vorausgesetzt werden, eine darüber hinausgehende Eindeutigkeit gibt es nicht notwendigerweise. Im Detail bedeutet das: Beim automatisierten ERSTELLEN des Dokuments durch eine Software sind Identifikatoren zu verwenden, die ZUMINDEST innerhalb des Dokuments eindeutig sind. Es genügt also beispielsweise das Durchnummerieren der im Dokument vorkommenden Objekte mit Ganzzahlen {1, 2, …, n}. Sofern vorhanden eignet sich aber auch die Verwendung von Identifikatoren, die über den Dokumentkontext hinaus eindeutig sind, da diese ebenfalls der Voraussetzung genügen, innerhalb des Dokuments eindeutig zu sein. Beim EINLESEN und VERARBEITEN eines Dokuments darf jedoch ausschließlich die dateninstanzweite Eindeutigkeit der Identifikatoren vorausgesetzt werden. Eine über den Dateninstanzkontext hinausgehende Zuordenbarkeit der Identifikatoren darf nicht angenommen werden! |
DocumentScopeReferenceIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeReferenceIdentifier [DocumentScopeReferenceIdentifierContentDocumentScopeReferenceIdentifierContent] |
1..1 |
Referenzierung eines Objekts mittels eines an anderer Stelle in der Dateninstanz dem Objekt zugewiesenen, im Dateninstanzkontext gültigen, Identifikators, ohne Möglichkeit der Angabe einer Rolle. |
DocumentScopeReferenceIdentifierContent
| Name/Typ | min..max | Definition |
|---|---|---|
DocumentScopeReferenceIdentifierContent Token64 |
1..1 |
Referenzierung eines Objekts mittels eines an anderer Stelle im Dokument dem Objekt zugewiesenen im Dokumentkontext gültigen Identifikators. |
FamilyNameText
| Name/Typ | min..max | Definition |
|---|---|---|
FamilyNameText Token40 |
1..1 |
Familienname. |
GivenNameText
| Name/Typ | min..max | Definition |
|---|---|---|
GivenNameText Token40 |
1..1 |
Vorname. |
Indicator
| Name/Typ | min..max | Definition |
|---|---|---|
Indicator xs:boolean |
1..1 |
Ja/Nein-Wert (Ja: Eigenschaft trifft zu; Nein: Eigenschaft trifft nicht zu). |
LongNameText
| Name/Typ | min..max | Definition |
|---|---|---|
LongNameText Token120 |
1..1 |
Name. |
NormalizedString256
| Name/Typ | min..max | Definition |
|---|---|---|
NormalizedString256 xs:normalizedString |
1..1 |
Wertebereich, zu dem alle normalisierten Zeichenketten gehören, die aus maximal 256 Zeichen bestehen. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette.Anmerkung: Eine normalisierte Zeichenkette ist eine Zeichenkette, die weder Carriage Return (#xD), Line Feed (#xA) noch Tabulatur (#x9) Zeichen enthält. |
NumericValue
| Name/Typ | min..max | Definition |
|---|---|---|
NumericValue |
1..1 |
Zahlenwert, z.B. für eine Größenangabe.Anmerkung: Je nach Größenart kann die Angabe einer Größeneinheit erforderlich sein, z.B. “Kilogramm”, “Millimeter”, “Milligramm pro Liter”. |
unitID Token64 |
0..1 |
Identifikation einer Größeneinheit, auf die sich die Zahlenwert-Größenangabe bezieht.Anmerkung: Welche Größeneinheiten zulässig sind, hängt vom Kontext ab, in dem der Datentyp verwendet wird. |
PredeterminedScopeAssignmentIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
PredeterminedScopeAssignmentIdentifier |
1..1 |
Einem Objekt zugeordneter, in einem bestimmten Kontext eindeutiger, und somit in diesem Kontext für die Objektidentifikation geeigneter Wert. Der Kontext der Vergabe, Zuweisung und Gültigkeit des Identifikators wird nicht explizit deklariert, sondern bei jeder Verwendung des Datentyps individuell vorgegeben. |
collectionDesignation NormalizedString256 |
0..1 |
Kennungstext für die Sammlung von Identifikatoren. |
PredeterminedScopeReferenceIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
PredeterminedScopeReferenceIdentifier |
1..1 |
Bezugnahme auf ein Objekt durch Angabe einer dem Objekt zugeordneten Identifikationszeichenkette.Beispiel: Bezugnahme auf eine Website durch Angabe der Website-Adresse (URL).Anmerkung: Die Sammlung von Identifikationszeichenketten, aus der die angegebene Identifikationszeichenkette stammt, wird nicht ausgewiesen, sondern ist durch den Kontext vorbestimmt: Im Falle von Website-Adressen braucht beispielsweise nicht explizit ausgewiesen zu werden, dass es sich um eine durch IANA/ICANN-akkreditierte Registrare registrierte URL handelt. Gleiches gilt beispielsweise für Telefonnummern, Faxnummern, E-Mail-Adressen und Hausnummern. |
ReferenceIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
ReferenceIdentifier |
1..1 |
Bezugnahme auf ein Objekt durch Angabe einer dem Objekt zugeordneten Identifikationszeichenkette.Beispiel: Bezugnahme auf eine Abfallart durch Angabe eine Abfallschlüsselnummer.Anmerkung: Zusätzlich zur Identifikationszeichenkette wird die ID jener Sammlung (z.B. Register oder Codeliste, etwa Abfallverzeichnis) angegeben, aus der die Identifikationszeichenkette stammt.Anmerkung: Auf welche Objekte zulässigerweise Bezug genommen werden kann, hängt vom Kontext ab, in dem der Datentyp verwendet wird. |
collectionID SimpleToken |
1..1 |
Identifikation der Sammlung (z.B. Register oder Codeliste), aus der die angegebene Identifikationszeichenkette stammt.Beispiel: Die vierstellige Nummer “3862” zur Identifikation der Codeliste “Länder”. |
objectDesignation NormalizedString256 |
0..1 |
Bezeichnung des Objekts, auf das Bezug genommen wird.Beispiel: Wird auf Finnland Bezug genommen, dann kann das wie folgt geschehen: Als Identifikationszeichenkette wird “246” eingetragen (dabei handelt es sich um den ISO 3166-1 Code von Finnland), als Identifikation der Sammlung “3862” (das ist die vierstellige Nummer der EDM-“Länder”-Codeliste), und als Objektbezeichnung “Finnland”. |
RelaxedReferenceNoRoleIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
RelaxedReferenceNoRoleIdentifier |
1..1 |
Referenzierung eines Objekts durch Angabe eines dem Objekt zugeordneten Identifikators, z.B. Referenzierung einer Abfallart durch eine Abfallschlüsselnummer. Zusätzlich zum Objekt-Identifkator wird die Identifikation der Sammlung von Identifikatoren (z.B. Register oder Codeliste, etwa Abfallverzeichnis) benötigt, der der Identifikator entstammt.Anmerkung: Aus welchen Sammlungen von Identifikatoren das referenzierte Objekt zulässigerweise stammen kann, hängt vom Kontext ab, in dem der Datentyp verwendet wird.Anmerkung: Der Datentyp “RelaxedReferenceNoRoleIdentifier” entspricht “ReferenceNoRoleIdentifier”, besitzt aber im Vergleich zu diesem einen erweiterten, weniger restriktiven Wertebereich. |
collectionID SimpleToken |
1..1 |
Identifikation der Sammlung von Identifikatoren (z.B. Register oder Codeliste), der der angegebene Objekt-Identifikator entstammt.Beispiel: Der Wert “3862” zur Identifikation der Codeliste “Länder”.Anmerkung: Welche Sammlungen von Identifikatoren zulässigerweise identifiziert werden können, hängt vom Kontext ab, in dem der Datentyp verwendet wird. |
objectDesignation NormalizedString256 |
0..1 |
Text, z.B. Name, der Personen dazu dient, das referenzierte Objekt zu erkennen und von anderen Objekten zu unterscheiden.Beispiel: Sollte etwa jener Eintrag aus der Codeliste 3862 (“Länder”) referenziert werden, der die Identifikation “246” trägt, dann wäre als Objekterkennungstext der aus der Codeliste stammende Name des Landes, “Finnland”, naheliegend.Anmerkung: Aus welchen Sammlungen von Identifikatoren das referenzierte Objekt zulässigerweise stammen kann, hängt vom Kontext ab, in dem der Datentyp verwendet wird. |
ShortNameText
| Name/Typ | min..max | Definition |
|---|---|---|
ShortNameText Token50 |
1..1 |
Name. |
SimpleToken
| Name/Typ | min..max | Definition |
|---|---|---|
SimpleToken xs:token |
1..1 |
Wertebereich, zu dem alle aus maximal 64 Zeichen bestehenden Zeichenketten gehören, die ausschließlich aus den Klein- und Großbuchstaben A-Z, den Ziffern 0-9, sowie dem Dash und/oder Underscore-Zeichen bestehen, und die nicht mit dem Dash bzw. Underscore-Zeichen beginnen oder enden. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette. |
String1024
| Name/Typ | min..max | Definition |
|---|---|---|
String1024 xs:string |
1..1 |
Wertebereich, zu dem alle aus maximal 1024 Zeichen bestehenden Zeichenketten gehören. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette. |
Time
| Name/Typ | min..max | Definition |
|---|---|---|
Time xs:time |
1..1 |
Uhrzeit (Zeitpunkt innerhalb eines Tags). |
Token120
| Name/Typ | min..max | Definition |
|---|---|---|
Token120 xs:token |
1..1 |
Wertebereich, zu dem alle Token bestehend aus maximal 120 Zeichen gehören. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette.Anmerkung: Ein Token ist eine Zeichenkette, die weder Carriage Return (#xD), Line Feed (#xA) noch Tabulator (#x9) Zeichen enthält, die nicht mit Leerzeichen (#x20) beginnt oder endet, und die keine Folge von zwei oder mehr aufeinanderfolgenden Leerzeichen enthält |
Token256
| Name/Typ | min..max | Definition |
|---|---|---|
Token256 xs:token |
1..1 |
Wertebereich, zu dem alle Token bestehend aus maximal 256 Zeichen gehören. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette.Anmerkung: Ein Token ist eine Zeichenkette, die weder Carriage Return (#xD), Line Feed (#xA) noch Tabulator (#x9) Zeichen enthält, die nicht mit Leerzeichen (#x20) beginnt oder endet, und die keine Folge von zwei oder mehr aufeinanderfolgenden Leerzeichen enthält |
Token40
| Name/Typ | min..max | Definition |
|---|---|---|
Token40 xs:token |
1..1 |
Wertebereich, zu dem alle Token bestehend aus maximal 40 Zeichen gehören. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette.Anmerkung: Ein Token ist eine Zeichenkette, die weder Carriage Return (#xD), Line Feed (#xA) noch Tabulator (#x9) Zeichen enthält, die nicht mit Leerzeichen (#x20) beginnt oder endet, und die keine Folge von zwei oder mehr aufeinanderfolgenden Leerzeichen enthält |
Token50
| Name/Typ | min..max | Definition |
|---|---|---|
Token50 xs:token |
1..1 |
Wertebereich, zu dem alle Token bestehend aus maximal 50 Zeichen gehören. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette.Anmerkung: Ein Token ist eine Zeichenkette, die weder Carriage Return (#xD), Line Feed (#xA) noch Tabulator (#x9) Zeichen enthält, die nicht mit Leerzeichen (#x20) beginnt oder endet, und die keine Folge von zwei oder mehr aufeinanderfolgenden Leerzeichen enthält |
Token64
| Name/Typ | min..max | Definition |
|---|---|---|
Token64 xs:token |
1..1 |
Wertebereich, zu dem alle Token bestehend aus maximal 64 Zeichen gehören. Ausnahme: Die aus 0 Zeichen bestehende Zeichenkette.Anmerkung: Ein Token ist eine Zeichenkette, die weder Carriage Return (#xD), Line Feed (#xA) noch Tabulator (#x9) Zeichen enthält, die nicht mit Leerzeichen (#x20) beginnt oder endet, und die keine Folge von zwei oder mehr aufeinanderfolgenden Leerzeichen enthält |
UUIDIdentifier
| Name/Typ | min..max | Definition |
|---|---|---|
UUIDIdentifier xs:string |
1..1 |
Universally Unique Identifier (ID, die dem Muster der kanonischen Darstellung von Universally Unique Identifier (UUID) entspricht). |