Dokument

Einleitung

Diese Dokumentation beschreibt das XML-Datenformat eines einzelnen Dokuments, das über die Newscube API abgerufen wurde. Das XML-Dokument enthält umfassende Informationen über ein bestimmtes Dokument und ist in einer hierarchischen Struktur organisiert. Dieser Bericht bietet eine detaillierte Erklärung der einzelnen Elemente und deren Bedeutung im XML-Dokument.

XML-Struktur

Das XML-Dokument besteht aus einem Hauptelement <document>, das Informationen über ein spezifisches Dokument enthält. Innerhalb des <document>-Elements gibt es das <meta>-Element, das Metadaten über das Dokument enthält, und das <content>-Element, das den eigentlichen Inhalt des Dokuments enthält. Das <content>-Element enthält Informationen über den Titel, den Untertitel und den Hauptinhalt des Dokuments. Es enthält auch Informationen über die zugehörigen Vorschaubilder und Anhänge. Hier ist die allgemeine Struktur des XML-Dokuments:

<document id="8acb0d34-68f0-42c2-8b69-eaca53bdccd3">
    <meta>
        <!-- Metadaten des Dokuments -->
    </meta>
    <content contentType="news">
        <!-- Inhalt des Dokuments -->
    </content>
    <previewImages>
        <!-- Vorschaubilder des Dokuments -->
    </previewImages>
</document>

Elemente und Bedeutung

document

Das document-Element ist das Hauptelement des XML-Dokuments und repräsentiert ein einzelnes Dokument. Es hat ein Attribut id, das eine eindeutige Kennung (UUID) für das Dokument angibt.

meta

Das meta-Element enthält Metadaten über das Dokument. Es enthält folgende Sub-Elemente:

  • <status>: Der Status des Dokuments (z. B. "new").
  • <createdAt>: Das Erstellungsdatum des Dokuments (in ISO 8601-Format).
  • <publishAt>: Das Veröffentlichungsdatum des Dokuments (in ISO 8601-Format).
  • <updatedAt>: Das Datum und die Uhrzeit der letzten Aktualisierung des Dokuments (in ISO 8601-Format).
  • <channel>: Informationen über den zugehörigen Kanal, der das Dokument veröffentlicht hat. Es hat ein Attribut id, das eine eindeutige Kennung (UUID) für den Kanal angibt, und enthält weitere Sub-Elemente für Titel, Beschreibung und Homepage des Kanals.
  • <streams>: Informationen über die zugehörigen Streams, die das Dokument enthalten. Es enthält ein <stream>-Element mit einem Attribut id, das die UUID des Streams angibt, und weiteren Sub-Elementen für den Titel und die URL des Streams.
  • <authors>: Informationen über die Autoren des Dokuments. Die Autoreninformationen können hier eingefügt werden.
  • <systemTags>: Informationen über Systemtags, die dem Dokument zugewiesen sind. Es enthält ein oder mehrere <systemTag>-Elemente, die Titel, ISIN und WKN des Tags enthalten.

content

Das content-Element enthält den eigentlichen Inhalt des Dokuments. Es hat ein Attribut contentType, das den Typ des Inhalts angibt (z. B. "news"). Es enthält folgende Sub-Elemente:

  • <title>: Der Titel des Dokuments (in CDATA-Format, um Sonderzeichen zu behandeln).
  • <subtitle>: Der Untertitel des Dokuments (in CDATA-Format).
  • <teaser>: Die Teaser-Textvorschau des Dokuments (in CDATA-Format).
  • <body>: Der Hauptinhalt des Dokuments, der möglicherweise HTML- und CSS-Tags enthält, um das Layout und die Formatierung zu steuern. Es hat ein Attribut layoutId, das eine eindeutige Kennung für das Layout des Inhalts angibt.

previewImages

Das previewImages-Element enthält Informationen über Vorschaubilder des Dokuments. Es enthält ein oder mehrere <previewImage>-Elemente mit Attributen für die UUID, den MIME-Typ, die URL und den Dateinamen des Vorschaubildes.

Zusammenfassung

Dieser XML-Dokumentationsbericht beschreibt die Struktur und die einzelnen Elemente des XML-Dokuments, das über die Newscube API abgerufen wurde. Das Dokument enthält Metadaten, den eigentlichen Inhalt sowie Vorschaubilder. Die bereitgestellten Informationen können von Entwicklern und Benutzern verwendet werden, um die Daten effektiv zu interpretieren und in ihren Anwendungen oder Analysen zu nutzen.