[0-17] INBOUND Schnittstelle zu Livingdocs API | Artikel mit Bilder

Übertragung per Restful API (https)

Artikel im JSON und Bilder als strukturiertes Objekt im JSON, Artikel-ID als eindeutiges Merkmal (document ID)

Zeitlich gesteuerter Poll durch PRINT NGEN (Pull alle 15 Sekunden, sofern vorhergehender Pull durchgeführt), Artikel-ID = eindeutiges Merkmal

Livingdocs

Feld

Inhalt

Option

"id"

ID des PublicationEvent

erforderlich

"createdAt"

Erstellungszeitpunkt

-

"projectId"

ID des Projektes

-

"channelId"

ID des Channels

-

"documentId"

ID des Artikels (erforderlich zum Abrufen des Artikel-JSON, vgl. 3.2)

erforderlich

"documentType"

“article” bei Artikeln

-

"contentType"

“print” bei Printartikeln

erforderlich

"eventType"

“publish” bei Printartikeln die zur Veröffentlichung in Print übertragen werden

-

"publicationId"

ID der Publikation

-

Feld

Inhalt

NGEN Eigenschaft

Option

"systemdata": { "documentId" }

ID des Artikels

DExterneId &

Teil von DTextName

erforderlich

"systemdata": { "contentType" }

“print” bei Printartikeln

-

"systemdata": { "documentType" }

“article” bei Artikeln

-

"metadata": { "title" }

Titel (siehe “Titel des Artikels” unten)

optional

"metadata": { "publish-date" oder: "publicationDate" }

Erscheinungstag im Format “2020-03-31”. Ein Erscheinungstag für alle übertragenen Ausgaben.

DTextErschAm

erforderlich, wenn der ET für alle Ausgaben gelten soll

"metadata": { "publications" oder: "publication": [{ "date" }]

Erscheinungstag im Format “2020-03-31”. Ein unterschiedlicher Erscheinungstag je übertragener Ausgabe (Alternative zu einem Erscheinungstag für alle übertragenen Ausgaben)

DTextErschAm

erforderlich, wenn je Ausgabe ein unterschiedlicher ET gelten soll

"metadata": { "publications" oder: "publication": [{ "object" }]

Objekt der Publikation

DTextObjekt

optional

"metadata": { "publications" oder: "publication": [{ "name" }]

Name der Publikation

-

"metadata": { "publications" oder: "publication": [{ "value" }]

Ausgabe der Publikation

DTextAusgabe

erforderlich

"metadata": { "publications" oder: "publication": [{ "category" }]

Ressort der Publikation

DTextRessort

erforderlich

"metadata": { "publications" oder: "publication": [{ "pageIndex" }]

Ressortindex der Publikation

DTextGeplSeite

optional;

für Assist

"metadata": { "publications" oder: "publication": [{ "printContentType" }]

Formatname (z. B. Aufmacher, Standard) (Infoboxen erhalten immer den Formatnamen “Infobox”)

DTextFormatName

optional;

für Assist

"metadata": { "publications" oder: "publication": [{ "printContentSubtype" }]

Formatname-Unterkategorie (z. B. Interview) (Infoboxen erhalten keine Unterkategorie, sondern nur “Infobox”)

Die Unterkategorie wird mit “#” an den Formatnamen (DTextFormatName) angehängt

optional;

für Assist

"metadata": { "publications" oder: "publication": [{"collective"}]

Kollektiv/Sonderthema der Publikation

DTextKollektiv

optional;

für Assist

"metadata": { "publications" oder: "publication": [{"partPageName"}]

Teilseiten-Name der Publikation

TeilseitenName

optional;

für Assist

"metadata": { "publications" oder: "publication": [{"status"}]

Status. Vorgesehene Werte:

• “Erfassung” für in Bearbeitung befindliche Artikel

• “Fertig” für fertige Artikel. Wird in PRINT NGEN ein Artikel manuell auf “Fertig” gestuft, erfolgt ein Preflight-Check. Wird ein Artikel direkt im Status "Fertig" übertragen, findet in PRINT NGEN für diesen Artikel kein Preflight-Check und keine Rechtschreibprüfung mehr statt. Die Rechtschreibprüfung muss entsprechend schon im Drittsystem erfolgen.

Status

optional;

für Assist;

Ohne Status wird standardmäßig “Status=Erfassung” gesetzt.

"metadata": { "publications" oder: "publication": [{"plannedSize"}]

Geplanter Umfang für unfertige Artikel. Angabe in T-Shirt-Größen in Großbuchstaben: XS, S, M, L, XL XXL

DTextErwarteterUmfang

optional;

für Assist;

Wird erwartet, wenn “status”: “Erfassung” übertragen wurde.

"metadata": { "publications" oder: "publication": [{"authorPosition”}]

Autoren-Position, vorgesehene Werte:

• AutorBereich

• AutorAnfang

• KuerzelAnfang

• KuerzelEnde

• OhneAutor

Weitere Infos unter: Mitwirkungspflichten: [0-17] Livingdocs API - Artikelvorlagen und Autor:innen

optional

"metadata": { "expire-date" }

Endzeitpunkt im Format 2020-04-02T14:10:00.000Z

-

Feld

Inhalt

Option

"component"

Element des Artikels, z. B.:

• image → Bild

• head oder header → Kopf

• lead-p → Vorspann

• p → Standard-Text

-

component: "head" oder: "header", content: { "catchline" }

Dachzeile des Artikels

optional

component: "head" oder: "header", content: { "title" }

Titel des Artikels

erforderlich

component: "head" oder: "header", content: { "lead" }

Unterzeile des Artikels

optional

component: "head" oder: "header", content: { "author" }

Autor:in des Artikels

optional

component: "head" oder: "header", content: { "authorShortnames" }

Autor:innenkürzel

optional

component: "head" oder: "header", content: { "city" }

Ortsmarke im Text des Artikels

optional

component: "lead-p", content: { "text" }

Vorspann des Artikels

optional

component: "lead-p", content: { "opener" }

Ortsmarkte im Vorspann des Artikels

optional

"position"

z. B. fixed

-

component: "p", content: { "text" }

Absatz eines Artikels

optional

component: “subtitle”, “content“: { “title“ }

Zwischentitel im Artikel

optional

component: “list”, “containers”: { “list” }

Liste im Artikel

optional

component: “list” , “containers”: { “list”: [{ “component”: “list-item”, “content”: { “text” }}]}

Listenelement

optional

component: “quote” , “content”: { “text” }

Zitat im Artikel

optional

component: “quote” , “content”: { “source” }

Autor:in/Quelle des Zitats

optional

component: "question" , "content": { "text" }

Frage

optional

component: "answer" , "content": { "text" }

Antwort

optional

component: "infobox","content": {

"title": "",

"text": "",

"image": {}

"caption": "",

"source": ""

}}

Infobox im Artikel (in PRINT NGEN als eigenständiger Artikel) mit oder ohne Bild.

Im Text sind Auszeichnungen (strong, em, p) möglich. Weitere Components (list, quote, question, answer) dürfen im Text nicht übergeben werden.

Für Infoboxbilder können die gleichen Felder übergeben werden wie bei den Artikelbildern.

optional

Feld

Inhalt

NGEN Eigenschaft

Option

component: "image", “content”: { “image”: { "originalUrl" }}

URL des Original-Bildes.

Wird standardmäßig zum Abholen des Bildes verwendet.

erforderlich

component: "image", “content”: { “image”: { "url" }}

URL des platzierten Bildes.

Wenn das Bild aus “originalUrl” nicht gefunden wird, wird das Bild aus “url” abgeholt.

optional

component: "image", “content”: { “image”: { "origins": { "name" }}}

Ursprung/Quelle des Bildes z. B. hugo.

Wird kein Ursprung übergeben wird standardmäßig BildUrsprung=Livingdocs gesetzt.

BildUrsprung

optional

component: "image", “content”: { “image”: { "origins": { "identifier" }}}

Bild-ID

DBildArchivID

optional

component: "image", “content”: { “image”: { "crop": { "x" }}}

X-Koordinate des Ausschnitts von links oben in 1/10000 Einheiten

Teil von BildAusschnitt

optional

component: "image", “content”: { “image”: { "crop": { "y" }}}

Y-Koordinate des Ausschnitts von links oben in 1/10000 Einheiten

Teil von BildAusschnitt

optional

component: "image", “content”: { “image”: { "crop": { "width" }}}

Breite des Ausschnitts in 1/10000 Einheiten relativ zur Gesamtbreite des Bildes

Teil von BildAusschnitt

optional

component: "image", “content”: { “image”: { "crop": { "height" }}}

Höhe des Ausschnitts in 1/10000 Einheiten relativ zur Gesamthöhe des Bildes

Teil von BildAusschnitt

optional

component: "image", “content”: { “image”: { "keepCrop" }}

Der übertragene oder volle Bildausschnitt ist fix. Wenn die Proportionen beim Platzieren durch Assist nicht eingehalten werden können, soll gelten:

• “MinimalVerzerren” (minimales Verzerren gemäß Rasterung des Bildes erlaubt)

• “Weissraum” (Freiraum im Bildbereich wird weiß ausgefüllt)

DBildAusschnittFest

optional;

für Assist;

Ohne Übertragung von “keepCrop” darf der Bildausschnitt durch Assist verändert werden.

component: "image", “content”: { "caption" }

Bildunterschrift

Text/BU

optional

component: "image", “content”: { "labelSource" }

Quellverweis

"labelSource" "source" werden in das Bildquelle-Tag der BU übernommen (in dieser Reihenfolge mit Leerzeichen getrennt)

optional

component: "image", “content”: { "source" }

Bildquelle

optional

component: "image", “content”: { "type" }

BildTyp

DBildTyp

optional;

für Assist