Stream

Einleitung

Diese Dokumentation beschreibt das XML-Datenformat, das über die Newscube API abgerufen wurde. Das XML-Dokument enthält Informationen zu einer Liste von Dokumenten, die durch das Hauptelement <documents> repräsentiert werden. Die Daten wurden mithilfe des API-Endpunkts "http://export.newscube.de/v2/documents/xml" abgerufen und enthalten eine Anfrage mit Statusinformationen sowie eine Liste von Dokumenten.

XML-Struktur

Das XML-Dokument besteht aus einer hierarchischen Baumstruktur mit verschiedenen Elementen, die Informationen über die Anfrage, den Stream und die Liste von Dokumenten enthalten. Hier ist die allgemeine Struktur des XML-Dokuments:

<documents count="30">
    <request>
        <!-- Informationen über die API-Anfrage -->
    </request>
    <stream id="8821480584db044351ede3331614015">
        <!-- Informationen über den Stream -->
    </stream>
    <document>
        <!-- Einzelnes Dokument (wiederholt sich für jede Dokumentinstanz) -->
    </document>
</documents>

Elemente und Bedeutung

documents

Das documents-Element ist das Hauptelement des XML-Dokuments und enthält die Liste von Dokumenten. Es hat ein Attribut count, das angibt, wie viele Dokumente in der Liste enthalten sind.

request

Das request-Element enthält Informationen über die API-Anfrage, die zum Abrufen der Dokumente verwendet wurde. Es enthält folgende Sub-Elemente:

  • <statusCode>: Der Statuscode der Anfrage (z. B. "200" für Erfolg).
  • <statusText>: Der Text, der den Status der Anfrage beschreibt (z. B. "Success" für Erfolg).
  • <requestDate>: Das Datum und die Uhrzeit der Anfrage (in ISO 8601-Format).
  • <serverIP>: Die IP-Adresse des Servers, der die Anfrage verarbeitet hat.

stream

Das stream-Element enthält Informationen über den Stream, der mit den abgerufenen Dokumenten verknüpft ist. Es hat ein Attribut id, das die eindeutige Kennung (UUID) des Streams angibt. Es enthält folgende Sub-Elemente:

  • <title>: Der Titel oder Name des Streams (in CDATA-Format, um Sonderzeichen zu behandeln).
  • <url>: Die URL des Streams, die auf die API verweist, um weitere Informationen über den Stream abzurufen.

document

Das document-Element repräsentiert ein einzelnes Dokument in der Liste. Es wird für jede Dokumentinstanz wiederholt. Die Details und Struktur des <document>-Elements sind nicht in diesem Bericht enthalten, da sie für jede spezifische Dokumentinstanz variieren können. Es wird jedoch darauf hingewiesen, dass es die Informationen über ein bestimmtes Dokument in strukturierter Form enthält.

Zusammenfassung

Dieser XML-Dokumentationsbericht beschreibt die Struktur und die einzelnen Elemente des XML-Dokuments, das über die Newscube API abgerufen wurde. Es enthält Informationen über die Anfrage, den zugehörigen Stream und die Liste von Dokumenten. 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.