Upload
others
View
0
Download
0
Embed Size (px)
Citation preview
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 1 von 39
Bearbeitungsstand final
Integrationsbeschreibung
METIS fuumlr Verlage
Dokumentinformation
Verantwortliche Franz Benjamin Noumlssler
Gespeichert am 16112021 0706
Dokumentversion 220
Dateiname CBeschreibung_Verlage_220doc
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 2 von 39
Bearbeitungsstand final
Aumlnderungsnachweis
Version Stand Aumlnderung Mitarbeiter
28 19022018 - Zusaumltzliche Meldemoumlglichkeit fuumlr Urheber ohne Wahrnehmungsvertrag
Franz B Noumlszligler
29 05062018 - Ergaumlnzungsmoumlglichkeit gemeldeter Beteiligter
Franz B Noumlszligler
210 06072018 Aumlnderung beim https Einbau (235) Franz B Noumlszligler
211 19122018 InfOnline durch Kantar Deutschland ersetzt Franz B Noumlszligler
212 14032019 Ergaumlnzung potenzielle Fehlerquelle Referrer-Tag (236) Anpassung Pruumlfung der Karteinummer (36) und Qualitaumltskontrolle (37)
Franz B Noumlszligler
213 19062019 Geaumlndertes Wartungsfenster Franz B Noumlszligler
214 20012020 Hinweis auf Lazy Load (Kapitel 237) Franz B Noumlszligler
215 18022020 Mind ein Autor bei einer Meldung Franz B Noumlszligler
216 12082020 PDFEPUB Einbauvariante (umschlieszligendes Tag) entfernt
Franz B Noumlszligler
217 22102020 Erweiterung erlaubte Zeichen verlagsinterner Schluumlssel um Bindestrich und Unterstrich (Kapitel 212)
Entfernen der Information dass kein Referrer-Tag zur erfolgreichen Zaumlhlung fuumlhrt (Kapitel 236)
Franz B Noumlszligler
218 27052021 Fehlermeldung fuumlr doppelt Base64-encodierte Texte METIS-PHP-Client Information entfernt
Franz B Noumlszligler
219 17062021 Nicht mehr guumlltiges Einbaubeispiel entfernt Franz B Noumlszligler
220 15112021 Hinzufuumlgen Ergaumlnzung gemeldeter Beteiligter Webservice (Kapitel 36) und Update Lazy Load (Kapitel 237)
Franz B Noumlszligler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 3 von 39
Bearbeitungsstand final
Inhaltsverzeichnis
1 Einleitung 5
11 Voraussetzung fuumlr die Verguumltung von Texten 5
12 Houmlhe der Tantieme5
13 Uumlberblick Ablauf 6
14 Technische Grundlagen 6
2 Zugriffszaumlhlung 7
21 Grundsaumltzliches zu Zaumlhlmarken 7
211 Zaumlhlmarken der VG WORT 7
212 Verlagsinterner Schluumlssel als Zaumlhlmarke7
213 Allgemein 8
214 Datenschutzerklaumlrung 8
22 Bestellen von Zaumlhlmarken 8
221 Bestellung uumlber Web Service Schnittstelle9
222 Bestellung uumlber Masken im Meldesystem 10
23 Einbau einer Zaumlhlmarke 11
231 Fuumlr HTML Texte 11
232 Fuumlr Dokumente (PDF oder EPUB Dateien) 11
233 Base64url enkodierte Zaumlhlmarken 12
234 Zaumlhlung von Texten hinter Bezahlschranken 12
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https) 13
236 Potenzielle Fehlerquelle Referrer-Tag 13
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo 14
24 Uumlberpruumlfen der Zaumlhlungen 14
241 Anzeige Herunterladen in der Anwendung 14
242 Abruf uumlber Web Service Schnittstelle 15
3 Meldung 16
31 Anforderungen an die Meldung 16
311 Eindeutiger Identif ikationscode 16
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen 16
313 Kurzbeschreibung Uumlberschrift (Titel) 17
314 Text 17
315 Erscheinungsorte (Webbereiche) 17
32 Meldung uumlbermitteln 17
321 Meldung uumlber Web Service Schnittstelle 17
322 Meldung uumlber Eingabemaske 22
33 Meldungsrecherche 22
331 Uumlber Web Service Schnittstelle 22
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 4 von 39
Bearbeitungsstand final
332 Uumlber Maske 23
34 Urhebermeldung 24
35 Pruumlfung der Karteinummer 24
351 Web Service Schnittstelle 24
36 Ergaumlnzung gemeldeter Beteiligter 25
361 Meldung uumlber Web Service Schnittstelle 25
362 Uumlber Maske 26
37 Qualitaumltskontrolle 28
371 Uumlber Web Service Schnittstelle 29
372 Uumlber Maske 30
38 Zugangsbeschraumlnkte Texte 30
4 Technische Verfahren Web Services 32
41 Authentifizierung 32
411 Autorisierungs- Authentif izierungsfehler 32
42 Datensicherheit 32
43 Versionierung 32
44 Nachrichten Ablauf 32
45 Testsystem 33
46 Probleme im Umgang mit Apache AXIS (ADB) 33
47 Beispiele fuumlr Web Service Aufrufe 33
471 PixelService 33
472 MessageService 34
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 5 von 39
Bearbeitungsstand final
1 Einleitung Dieses Dokument dient als Beschreibung fuumlr Verlage die am METIS Verfahren teilnehmen wollen Es beinhaltet sowohl die generelle Verfahrensbeschreibung wie auch die technische Beschreibung der eingesetzten Schnittstellen Es basiert auf langjaumlhriger Erfahrung dadurch sind bereits Erfahrungswerte sowie Probleme bei vergangenen Integrationen eingeflossen
Um an METIS teilnehmen zu koumlnnen ist eine einmalige Meldesystemregistrierung unter httptomvgwortde noumltig
11 Voraussetzung fuumlr die Verguumltung von Texten
Bei METIS wird die Zweitverwertung von Texten im Internet verguumltet (dh Kopien die von den im Internet zur Verfuumlgung gestellten Texten angefertigt werden) Aus diesem Grund werden Texte ausgeschlossen die einen technischen Kopierschutz enthalten
Da es nicht moumlglich ist den technischen Kopiervorgang festzustellen trifft die VG WORT die Annahme dass es einen Zusammenhang zwischen der Nutzung und der Zweitverwertung von einem Text gibt Dh man geht davon aus dass Texte die haumlufig gelesen werden auch haumlufig kopiert werden Aus diesem Grund muumlssen die Texte im Rahmen eines Zaumlhlverfahrens individuell gezaumlhlt werden Fuumlr die Ausschuumlttung werden Texte herangezogen deren Zugriffszaumlhlung einen festgelegten Mindestzugriff erreichen Der Mindestzugriff wird von der VG WORT fuumlr ein Kalenderjahr im Januar des Folgejahres im Meldesystem festgelegt Fuumlr das Jahr 2014 musste ein Text mit einer Laumlnge unter 10000 Zeichen 1500 Visits Jahr erreichen Bei einer Textlaumlnge von zumindest 10000 Zeichen hat sich der Mindestzugriff auf 750 Visits Jahr reduziert (Anteiliger Mindestzugriff) Zaumlhlungen von Texten hinter Bezahlschranken werden ab dem Jahr 2016 mit Faktor 3 multipliziert Weiterfuumlhrende Informationen finden Sie auf der Homepage der VG WORT
- Verteilungsplan httpwwwvgwortdepublikationen-dokumenteverteilungsplaenehtml (sect 58 und sect 59)
- Quoten httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Kapitel bdquoMETISldquo)
Ein weiteres Kriterium betrifft die Textlaumlnge Die Texte muumlssen eine Mindestlaumlnge von 1800 Zeichen (inkl Leerzeichen) erreichen Die Ausnahme bilden Gedichte ndash diese koumlnnen auch kuumlrzer sein
Zusammenfassung der Kriterien - Text muss im Internet veroumlffentlicht sein - Kein Kopierschutz (hartes DRM) - Mindestlaumlnge 1800 Zeichen (ausgenommen Lyrik) - Der festgelegte Mindestzugriff muss erreicht werden
12 Houmlhe der Tantieme
Die Houmlhe der Tantieme wird von der VG WORT fuumlr ein Kalenderjahr im Nachhinein (Mai Juni) festgelegt Die Tantieme besteht aus einem Verlagsanteil und einem Autorenanteil Die aktuellen Tantiemen und Modalitaumlten finden Sie in der Quotenuumlbersicht auf der Homepage der VG WORT unter httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Abschnitt bdquoMETISldquo)
Zu beachten ist dass die Houmlhe der Tantieme pro Text angegeben ist der die oben genannten Voraussetzungen erfuumlllt Dadurch sollten sich bei Verlagen die pro Jahr einige hundert oder tausend solcher Texte veroumlffentlichen die Investitionskosten rasch amortisieren
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 6 von 39
Bearbeitungsstand final
13 Uumlberblick Ablauf
Um eine Tantieme zu erhalten sind pro Text nur drei Schritte noumltig
1) Zugriffszaumlhlung
2) Meldung uumlbermitteln
3) Ausschuumlttung erhalten
Die Grundlage fuumlr die Ausschuumlttung bilden die Zugriffszahlen daher ist es wichtig so schnell und so vollstaumlndig wie moumlglich mit der Zugriffszaumlhlung zu beginnen (siehe Kapitel bdquo2 Zugriffszaumlhlungldquo) Fuumlr eine spaumltere Meldung muss die dabei vergebene Zaumlhlmarke intern mit dem Text verknuumlpft werden Jeder Text muss dabei mit einer eigenen Zaumlhlmarke versehen werden
Der zweite Schritt ist die Uumlbermittlung der Meldung (siehe Kapitel bdquo3 Meldungldquo) Dabei wird der Text die Veroumlffentlichungsorte (URLs) sowie alle beteiligten Autoren und Uumlbersetzer an die VG WORT gemeldet
Nach Erstellung der Meldung pruumlft die VG WORT bei jedem Text ob er den Kriterien fuumlr die Ausschuumlttung entspricht Ist das der Fall erfolgt automatisch die Ausschuumlttung
14 Technische Grundlagen
Jeder beschriebene Schritt laumlsst sich manuell uumlber Meldemasken oder automatisiert uumlber Web Service Schnittstellen bedienen Die manuelle Variante ist fuumlr kleinere Verlage empfohlen (bis ca 100 Texte Jahr) Ansonsten empfiehlt sich eine vollautomatische Integration uumlber die Schnittstellen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 7 von 39
Bearbeitungsstand final
2 Zugriffszaumlhlung Fuumlr die Zugriffszaumlhlung wird das bdquoskalierbare zentrale Messsystemldquo dass auch fuumlr die Werbewirtschaft (IVW) eingesetzt wird verwendet Dabei werden in HTML Seiten unsichtbare Bilder (Zaumlhlmarken) eingebaut die zu Zugriffszaumlhlungen fuumlhren
Die Zugriffszaumlhlung bildet die Basis fuumlr eine moumlgliche Ausschuumlttung Aus diesem Grund muss darauf geachtet werden moumlglichst alle Texte die fuumlr die Ausschuumlttung in Frage kommen zu zaumlhlen
Viele Artikel haben am Erscheinungstag die meisten Zugriffe Achten Sie unbedingt darauf dass Sie die Artikel sofort beim Erscheinen mit einer Zaumlhlmarke versehen da ansonsten moumlglicherweise der festgelegte Mindestzugriff nicht mehr erreicht werden kann
Bei den bisher teilnehmenden Verlagen hat es sich bewaumlhrt als Erstes mit der Zaumlhlung von neu erscheinenden Artikeln zu beginnen Erst sobald das reibungslos automatisiert funktioniert sollte man sich die Frage stellen ob man aumlltere Artikel (zB Archiv hellip) nachtraumlglich mit Zaumlhlmarken ausstatten moumlchte Eine Empfehlung dafuumlr oder dagegen kann man generell nicht aussprechen da es davon abhaumlngt wie stark solche Archivinhalte genutzt werden Das sollte im Verlag anhand von Kosten Nutzen entschieden werden
21 Grundsaumltzliches zu Zaumlhlmarken
211 Zaumlhlmarken der VG WORT
Jede Zaumlhlmarke besteht aus zwei Teilen (oumlffentlicher Identifikationscode privater Identifikationscode) Der oumlf fentliche Identifikationscode dient zum Einbau in die jeweilige HTML ndash Seite (siehe Kapitel 23 Einbau einer Zaumlhlmarke) Der private Identifikationscode wird spaumlter im Rahmen der Meldung benoumltigt
Aus diesem Grund muss der private Identifikationscode in Ihrem CMS System mit dem Artikel verknuumlpft werden
212 Verlagsinterner Schluumlssel als Zaumlhlmarke
In Verlagen werden die Artikel oftmals mit eindeutigen internen Schluumlsseln versehen Diese internen Schluumlssel koumlnnen ebenfalls als Zaumlhlmarke verwendet werden In diesem Fall wird sowohl fuumlr den oumlf fentlichen als auch fuumlr den privaten Identifikationscode der verlagsinterne Schluumlssel verwendet
Dabei gibt es folgendes zu beachten
- Ein verlagsinterner Schluumlssel setzt sich aus dem Praumlfix bdquovgzmltKarteinummergt-ldquo und einen beliebigen Schluumlssel zusammen Der Platzhalter bdquoltKarteinummergtldquo muss mit der VGWORT Karteinummer des Verlags ersetzt werden
- Der Schluumlssel darf keine Sonderzeichen enthalten (dh nur [a-z][A-Z][0-9] sowie den Punkt den Bindestrich und den Unterstrich)
- Der Schluumlssel muss innerhalb vom Verlag eindeutig sein
- DOI (httpwwwdoiorg) koumlnnen ebenfalls als verlagsinterne Schluumlssel zum Einsatz kommen Der Slash nach der Verlagskennung muss durch einen Bindestrich (-) ersetzt werden Es duumlrfen im DOI auch keine weiteren Slashes vorkommen
Beispiel vgzm970-123456789
Bitte setzen Sie sich vor Verwendung von verlagsinternen Schluumlsseln als Zaumlhlmarke unbedingt mit der VG WORT in Verbindung (per Email an metissupportvgwortde) Sie erhalten dann eine Zaumlhldomaumlne die Sie fuumlr den Einbau der Zaumlhlmarken benoumltigen und Sie werden fuumlr die Zugriffszaumlhlung mit verlagsinternen Schluumlsseln freigeschalten Ohne diese Schritte ist keine Zaumlhlung mit verlagsinternen Schluumlsseln moumlglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 2 von 39
Bearbeitungsstand final
Aumlnderungsnachweis
Version Stand Aumlnderung Mitarbeiter
28 19022018 - Zusaumltzliche Meldemoumlglichkeit fuumlr Urheber ohne Wahrnehmungsvertrag
Franz B Noumlszligler
29 05062018 - Ergaumlnzungsmoumlglichkeit gemeldeter Beteiligter
Franz B Noumlszligler
210 06072018 Aumlnderung beim https Einbau (235) Franz B Noumlszligler
211 19122018 InfOnline durch Kantar Deutschland ersetzt Franz B Noumlszligler
212 14032019 Ergaumlnzung potenzielle Fehlerquelle Referrer-Tag (236) Anpassung Pruumlfung der Karteinummer (36) und Qualitaumltskontrolle (37)
Franz B Noumlszligler
213 19062019 Geaumlndertes Wartungsfenster Franz B Noumlszligler
214 20012020 Hinweis auf Lazy Load (Kapitel 237) Franz B Noumlszligler
215 18022020 Mind ein Autor bei einer Meldung Franz B Noumlszligler
216 12082020 PDFEPUB Einbauvariante (umschlieszligendes Tag) entfernt
Franz B Noumlszligler
217 22102020 Erweiterung erlaubte Zeichen verlagsinterner Schluumlssel um Bindestrich und Unterstrich (Kapitel 212)
Entfernen der Information dass kein Referrer-Tag zur erfolgreichen Zaumlhlung fuumlhrt (Kapitel 236)
Franz B Noumlszligler
218 27052021 Fehlermeldung fuumlr doppelt Base64-encodierte Texte METIS-PHP-Client Information entfernt
Franz B Noumlszligler
219 17062021 Nicht mehr guumlltiges Einbaubeispiel entfernt Franz B Noumlszligler
220 15112021 Hinzufuumlgen Ergaumlnzung gemeldeter Beteiligter Webservice (Kapitel 36) und Update Lazy Load (Kapitel 237)
Franz B Noumlszligler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 3 von 39
Bearbeitungsstand final
Inhaltsverzeichnis
1 Einleitung 5
11 Voraussetzung fuumlr die Verguumltung von Texten 5
12 Houmlhe der Tantieme5
13 Uumlberblick Ablauf 6
14 Technische Grundlagen 6
2 Zugriffszaumlhlung 7
21 Grundsaumltzliches zu Zaumlhlmarken 7
211 Zaumlhlmarken der VG WORT 7
212 Verlagsinterner Schluumlssel als Zaumlhlmarke7
213 Allgemein 8
214 Datenschutzerklaumlrung 8
22 Bestellen von Zaumlhlmarken 8
221 Bestellung uumlber Web Service Schnittstelle9
222 Bestellung uumlber Masken im Meldesystem 10
23 Einbau einer Zaumlhlmarke 11
231 Fuumlr HTML Texte 11
232 Fuumlr Dokumente (PDF oder EPUB Dateien) 11
233 Base64url enkodierte Zaumlhlmarken 12
234 Zaumlhlung von Texten hinter Bezahlschranken 12
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https) 13
236 Potenzielle Fehlerquelle Referrer-Tag 13
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo 14
24 Uumlberpruumlfen der Zaumlhlungen 14
241 Anzeige Herunterladen in der Anwendung 14
242 Abruf uumlber Web Service Schnittstelle 15
3 Meldung 16
31 Anforderungen an die Meldung 16
311 Eindeutiger Identif ikationscode 16
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen 16
313 Kurzbeschreibung Uumlberschrift (Titel) 17
314 Text 17
315 Erscheinungsorte (Webbereiche) 17
32 Meldung uumlbermitteln 17
321 Meldung uumlber Web Service Schnittstelle 17
322 Meldung uumlber Eingabemaske 22
33 Meldungsrecherche 22
331 Uumlber Web Service Schnittstelle 22
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 4 von 39
Bearbeitungsstand final
332 Uumlber Maske 23
34 Urhebermeldung 24
35 Pruumlfung der Karteinummer 24
351 Web Service Schnittstelle 24
36 Ergaumlnzung gemeldeter Beteiligter 25
361 Meldung uumlber Web Service Schnittstelle 25
362 Uumlber Maske 26
37 Qualitaumltskontrolle 28
371 Uumlber Web Service Schnittstelle 29
372 Uumlber Maske 30
38 Zugangsbeschraumlnkte Texte 30
4 Technische Verfahren Web Services 32
41 Authentifizierung 32
411 Autorisierungs- Authentif izierungsfehler 32
42 Datensicherheit 32
43 Versionierung 32
44 Nachrichten Ablauf 32
45 Testsystem 33
46 Probleme im Umgang mit Apache AXIS (ADB) 33
47 Beispiele fuumlr Web Service Aufrufe 33
471 PixelService 33
472 MessageService 34
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 5 von 39
Bearbeitungsstand final
1 Einleitung Dieses Dokument dient als Beschreibung fuumlr Verlage die am METIS Verfahren teilnehmen wollen Es beinhaltet sowohl die generelle Verfahrensbeschreibung wie auch die technische Beschreibung der eingesetzten Schnittstellen Es basiert auf langjaumlhriger Erfahrung dadurch sind bereits Erfahrungswerte sowie Probleme bei vergangenen Integrationen eingeflossen
Um an METIS teilnehmen zu koumlnnen ist eine einmalige Meldesystemregistrierung unter httptomvgwortde noumltig
11 Voraussetzung fuumlr die Verguumltung von Texten
Bei METIS wird die Zweitverwertung von Texten im Internet verguumltet (dh Kopien die von den im Internet zur Verfuumlgung gestellten Texten angefertigt werden) Aus diesem Grund werden Texte ausgeschlossen die einen technischen Kopierschutz enthalten
Da es nicht moumlglich ist den technischen Kopiervorgang festzustellen trifft die VG WORT die Annahme dass es einen Zusammenhang zwischen der Nutzung und der Zweitverwertung von einem Text gibt Dh man geht davon aus dass Texte die haumlufig gelesen werden auch haumlufig kopiert werden Aus diesem Grund muumlssen die Texte im Rahmen eines Zaumlhlverfahrens individuell gezaumlhlt werden Fuumlr die Ausschuumlttung werden Texte herangezogen deren Zugriffszaumlhlung einen festgelegten Mindestzugriff erreichen Der Mindestzugriff wird von der VG WORT fuumlr ein Kalenderjahr im Januar des Folgejahres im Meldesystem festgelegt Fuumlr das Jahr 2014 musste ein Text mit einer Laumlnge unter 10000 Zeichen 1500 Visits Jahr erreichen Bei einer Textlaumlnge von zumindest 10000 Zeichen hat sich der Mindestzugriff auf 750 Visits Jahr reduziert (Anteiliger Mindestzugriff) Zaumlhlungen von Texten hinter Bezahlschranken werden ab dem Jahr 2016 mit Faktor 3 multipliziert Weiterfuumlhrende Informationen finden Sie auf der Homepage der VG WORT
- Verteilungsplan httpwwwvgwortdepublikationen-dokumenteverteilungsplaenehtml (sect 58 und sect 59)
- Quoten httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Kapitel bdquoMETISldquo)
Ein weiteres Kriterium betrifft die Textlaumlnge Die Texte muumlssen eine Mindestlaumlnge von 1800 Zeichen (inkl Leerzeichen) erreichen Die Ausnahme bilden Gedichte ndash diese koumlnnen auch kuumlrzer sein
Zusammenfassung der Kriterien - Text muss im Internet veroumlffentlicht sein - Kein Kopierschutz (hartes DRM) - Mindestlaumlnge 1800 Zeichen (ausgenommen Lyrik) - Der festgelegte Mindestzugriff muss erreicht werden
12 Houmlhe der Tantieme
Die Houmlhe der Tantieme wird von der VG WORT fuumlr ein Kalenderjahr im Nachhinein (Mai Juni) festgelegt Die Tantieme besteht aus einem Verlagsanteil und einem Autorenanteil Die aktuellen Tantiemen und Modalitaumlten finden Sie in der Quotenuumlbersicht auf der Homepage der VG WORT unter httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Abschnitt bdquoMETISldquo)
Zu beachten ist dass die Houmlhe der Tantieme pro Text angegeben ist der die oben genannten Voraussetzungen erfuumlllt Dadurch sollten sich bei Verlagen die pro Jahr einige hundert oder tausend solcher Texte veroumlffentlichen die Investitionskosten rasch amortisieren
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 6 von 39
Bearbeitungsstand final
13 Uumlberblick Ablauf
Um eine Tantieme zu erhalten sind pro Text nur drei Schritte noumltig
1) Zugriffszaumlhlung
2) Meldung uumlbermitteln
3) Ausschuumlttung erhalten
Die Grundlage fuumlr die Ausschuumlttung bilden die Zugriffszahlen daher ist es wichtig so schnell und so vollstaumlndig wie moumlglich mit der Zugriffszaumlhlung zu beginnen (siehe Kapitel bdquo2 Zugriffszaumlhlungldquo) Fuumlr eine spaumltere Meldung muss die dabei vergebene Zaumlhlmarke intern mit dem Text verknuumlpft werden Jeder Text muss dabei mit einer eigenen Zaumlhlmarke versehen werden
Der zweite Schritt ist die Uumlbermittlung der Meldung (siehe Kapitel bdquo3 Meldungldquo) Dabei wird der Text die Veroumlffentlichungsorte (URLs) sowie alle beteiligten Autoren und Uumlbersetzer an die VG WORT gemeldet
Nach Erstellung der Meldung pruumlft die VG WORT bei jedem Text ob er den Kriterien fuumlr die Ausschuumlttung entspricht Ist das der Fall erfolgt automatisch die Ausschuumlttung
14 Technische Grundlagen
Jeder beschriebene Schritt laumlsst sich manuell uumlber Meldemasken oder automatisiert uumlber Web Service Schnittstellen bedienen Die manuelle Variante ist fuumlr kleinere Verlage empfohlen (bis ca 100 Texte Jahr) Ansonsten empfiehlt sich eine vollautomatische Integration uumlber die Schnittstellen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 7 von 39
Bearbeitungsstand final
2 Zugriffszaumlhlung Fuumlr die Zugriffszaumlhlung wird das bdquoskalierbare zentrale Messsystemldquo dass auch fuumlr die Werbewirtschaft (IVW) eingesetzt wird verwendet Dabei werden in HTML Seiten unsichtbare Bilder (Zaumlhlmarken) eingebaut die zu Zugriffszaumlhlungen fuumlhren
Die Zugriffszaumlhlung bildet die Basis fuumlr eine moumlgliche Ausschuumlttung Aus diesem Grund muss darauf geachtet werden moumlglichst alle Texte die fuumlr die Ausschuumlttung in Frage kommen zu zaumlhlen
Viele Artikel haben am Erscheinungstag die meisten Zugriffe Achten Sie unbedingt darauf dass Sie die Artikel sofort beim Erscheinen mit einer Zaumlhlmarke versehen da ansonsten moumlglicherweise der festgelegte Mindestzugriff nicht mehr erreicht werden kann
Bei den bisher teilnehmenden Verlagen hat es sich bewaumlhrt als Erstes mit der Zaumlhlung von neu erscheinenden Artikeln zu beginnen Erst sobald das reibungslos automatisiert funktioniert sollte man sich die Frage stellen ob man aumlltere Artikel (zB Archiv hellip) nachtraumlglich mit Zaumlhlmarken ausstatten moumlchte Eine Empfehlung dafuumlr oder dagegen kann man generell nicht aussprechen da es davon abhaumlngt wie stark solche Archivinhalte genutzt werden Das sollte im Verlag anhand von Kosten Nutzen entschieden werden
21 Grundsaumltzliches zu Zaumlhlmarken
211 Zaumlhlmarken der VG WORT
Jede Zaumlhlmarke besteht aus zwei Teilen (oumlffentlicher Identifikationscode privater Identifikationscode) Der oumlf fentliche Identifikationscode dient zum Einbau in die jeweilige HTML ndash Seite (siehe Kapitel 23 Einbau einer Zaumlhlmarke) Der private Identifikationscode wird spaumlter im Rahmen der Meldung benoumltigt
Aus diesem Grund muss der private Identifikationscode in Ihrem CMS System mit dem Artikel verknuumlpft werden
212 Verlagsinterner Schluumlssel als Zaumlhlmarke
In Verlagen werden die Artikel oftmals mit eindeutigen internen Schluumlsseln versehen Diese internen Schluumlssel koumlnnen ebenfalls als Zaumlhlmarke verwendet werden In diesem Fall wird sowohl fuumlr den oumlf fentlichen als auch fuumlr den privaten Identifikationscode der verlagsinterne Schluumlssel verwendet
Dabei gibt es folgendes zu beachten
- Ein verlagsinterner Schluumlssel setzt sich aus dem Praumlfix bdquovgzmltKarteinummergt-ldquo und einen beliebigen Schluumlssel zusammen Der Platzhalter bdquoltKarteinummergtldquo muss mit der VGWORT Karteinummer des Verlags ersetzt werden
- Der Schluumlssel darf keine Sonderzeichen enthalten (dh nur [a-z][A-Z][0-9] sowie den Punkt den Bindestrich und den Unterstrich)
- Der Schluumlssel muss innerhalb vom Verlag eindeutig sein
- DOI (httpwwwdoiorg) koumlnnen ebenfalls als verlagsinterne Schluumlssel zum Einsatz kommen Der Slash nach der Verlagskennung muss durch einen Bindestrich (-) ersetzt werden Es duumlrfen im DOI auch keine weiteren Slashes vorkommen
Beispiel vgzm970-123456789
Bitte setzen Sie sich vor Verwendung von verlagsinternen Schluumlsseln als Zaumlhlmarke unbedingt mit der VG WORT in Verbindung (per Email an metissupportvgwortde) Sie erhalten dann eine Zaumlhldomaumlne die Sie fuumlr den Einbau der Zaumlhlmarken benoumltigen und Sie werden fuumlr die Zugriffszaumlhlung mit verlagsinternen Schluumlsseln freigeschalten Ohne diese Schritte ist keine Zaumlhlung mit verlagsinternen Schluumlsseln moumlglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 3 von 39
Bearbeitungsstand final
Inhaltsverzeichnis
1 Einleitung 5
11 Voraussetzung fuumlr die Verguumltung von Texten 5
12 Houmlhe der Tantieme5
13 Uumlberblick Ablauf 6
14 Technische Grundlagen 6
2 Zugriffszaumlhlung 7
21 Grundsaumltzliches zu Zaumlhlmarken 7
211 Zaumlhlmarken der VG WORT 7
212 Verlagsinterner Schluumlssel als Zaumlhlmarke7
213 Allgemein 8
214 Datenschutzerklaumlrung 8
22 Bestellen von Zaumlhlmarken 8
221 Bestellung uumlber Web Service Schnittstelle9
222 Bestellung uumlber Masken im Meldesystem 10
23 Einbau einer Zaumlhlmarke 11
231 Fuumlr HTML Texte 11
232 Fuumlr Dokumente (PDF oder EPUB Dateien) 11
233 Base64url enkodierte Zaumlhlmarken 12
234 Zaumlhlung von Texten hinter Bezahlschranken 12
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https) 13
236 Potenzielle Fehlerquelle Referrer-Tag 13
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo 14
24 Uumlberpruumlfen der Zaumlhlungen 14
241 Anzeige Herunterladen in der Anwendung 14
242 Abruf uumlber Web Service Schnittstelle 15
3 Meldung 16
31 Anforderungen an die Meldung 16
311 Eindeutiger Identif ikationscode 16
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen 16
313 Kurzbeschreibung Uumlberschrift (Titel) 17
314 Text 17
315 Erscheinungsorte (Webbereiche) 17
32 Meldung uumlbermitteln 17
321 Meldung uumlber Web Service Schnittstelle 17
322 Meldung uumlber Eingabemaske 22
33 Meldungsrecherche 22
331 Uumlber Web Service Schnittstelle 22
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 4 von 39
Bearbeitungsstand final
332 Uumlber Maske 23
34 Urhebermeldung 24
35 Pruumlfung der Karteinummer 24
351 Web Service Schnittstelle 24
36 Ergaumlnzung gemeldeter Beteiligter 25
361 Meldung uumlber Web Service Schnittstelle 25
362 Uumlber Maske 26
37 Qualitaumltskontrolle 28
371 Uumlber Web Service Schnittstelle 29
372 Uumlber Maske 30
38 Zugangsbeschraumlnkte Texte 30
4 Technische Verfahren Web Services 32
41 Authentifizierung 32
411 Autorisierungs- Authentif izierungsfehler 32
42 Datensicherheit 32
43 Versionierung 32
44 Nachrichten Ablauf 32
45 Testsystem 33
46 Probleme im Umgang mit Apache AXIS (ADB) 33
47 Beispiele fuumlr Web Service Aufrufe 33
471 PixelService 33
472 MessageService 34
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 5 von 39
Bearbeitungsstand final
1 Einleitung Dieses Dokument dient als Beschreibung fuumlr Verlage die am METIS Verfahren teilnehmen wollen Es beinhaltet sowohl die generelle Verfahrensbeschreibung wie auch die technische Beschreibung der eingesetzten Schnittstellen Es basiert auf langjaumlhriger Erfahrung dadurch sind bereits Erfahrungswerte sowie Probleme bei vergangenen Integrationen eingeflossen
Um an METIS teilnehmen zu koumlnnen ist eine einmalige Meldesystemregistrierung unter httptomvgwortde noumltig
11 Voraussetzung fuumlr die Verguumltung von Texten
Bei METIS wird die Zweitverwertung von Texten im Internet verguumltet (dh Kopien die von den im Internet zur Verfuumlgung gestellten Texten angefertigt werden) Aus diesem Grund werden Texte ausgeschlossen die einen technischen Kopierschutz enthalten
Da es nicht moumlglich ist den technischen Kopiervorgang festzustellen trifft die VG WORT die Annahme dass es einen Zusammenhang zwischen der Nutzung und der Zweitverwertung von einem Text gibt Dh man geht davon aus dass Texte die haumlufig gelesen werden auch haumlufig kopiert werden Aus diesem Grund muumlssen die Texte im Rahmen eines Zaumlhlverfahrens individuell gezaumlhlt werden Fuumlr die Ausschuumlttung werden Texte herangezogen deren Zugriffszaumlhlung einen festgelegten Mindestzugriff erreichen Der Mindestzugriff wird von der VG WORT fuumlr ein Kalenderjahr im Januar des Folgejahres im Meldesystem festgelegt Fuumlr das Jahr 2014 musste ein Text mit einer Laumlnge unter 10000 Zeichen 1500 Visits Jahr erreichen Bei einer Textlaumlnge von zumindest 10000 Zeichen hat sich der Mindestzugriff auf 750 Visits Jahr reduziert (Anteiliger Mindestzugriff) Zaumlhlungen von Texten hinter Bezahlschranken werden ab dem Jahr 2016 mit Faktor 3 multipliziert Weiterfuumlhrende Informationen finden Sie auf der Homepage der VG WORT
- Verteilungsplan httpwwwvgwortdepublikationen-dokumenteverteilungsplaenehtml (sect 58 und sect 59)
- Quoten httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Kapitel bdquoMETISldquo)
Ein weiteres Kriterium betrifft die Textlaumlnge Die Texte muumlssen eine Mindestlaumlnge von 1800 Zeichen (inkl Leerzeichen) erreichen Die Ausnahme bilden Gedichte ndash diese koumlnnen auch kuumlrzer sein
Zusammenfassung der Kriterien - Text muss im Internet veroumlffentlicht sein - Kein Kopierschutz (hartes DRM) - Mindestlaumlnge 1800 Zeichen (ausgenommen Lyrik) - Der festgelegte Mindestzugriff muss erreicht werden
12 Houmlhe der Tantieme
Die Houmlhe der Tantieme wird von der VG WORT fuumlr ein Kalenderjahr im Nachhinein (Mai Juni) festgelegt Die Tantieme besteht aus einem Verlagsanteil und einem Autorenanteil Die aktuellen Tantiemen und Modalitaumlten finden Sie in der Quotenuumlbersicht auf der Homepage der VG WORT unter httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Abschnitt bdquoMETISldquo)
Zu beachten ist dass die Houmlhe der Tantieme pro Text angegeben ist der die oben genannten Voraussetzungen erfuumlllt Dadurch sollten sich bei Verlagen die pro Jahr einige hundert oder tausend solcher Texte veroumlffentlichen die Investitionskosten rasch amortisieren
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 6 von 39
Bearbeitungsstand final
13 Uumlberblick Ablauf
Um eine Tantieme zu erhalten sind pro Text nur drei Schritte noumltig
1) Zugriffszaumlhlung
2) Meldung uumlbermitteln
3) Ausschuumlttung erhalten
Die Grundlage fuumlr die Ausschuumlttung bilden die Zugriffszahlen daher ist es wichtig so schnell und so vollstaumlndig wie moumlglich mit der Zugriffszaumlhlung zu beginnen (siehe Kapitel bdquo2 Zugriffszaumlhlungldquo) Fuumlr eine spaumltere Meldung muss die dabei vergebene Zaumlhlmarke intern mit dem Text verknuumlpft werden Jeder Text muss dabei mit einer eigenen Zaumlhlmarke versehen werden
Der zweite Schritt ist die Uumlbermittlung der Meldung (siehe Kapitel bdquo3 Meldungldquo) Dabei wird der Text die Veroumlffentlichungsorte (URLs) sowie alle beteiligten Autoren und Uumlbersetzer an die VG WORT gemeldet
Nach Erstellung der Meldung pruumlft die VG WORT bei jedem Text ob er den Kriterien fuumlr die Ausschuumlttung entspricht Ist das der Fall erfolgt automatisch die Ausschuumlttung
14 Technische Grundlagen
Jeder beschriebene Schritt laumlsst sich manuell uumlber Meldemasken oder automatisiert uumlber Web Service Schnittstellen bedienen Die manuelle Variante ist fuumlr kleinere Verlage empfohlen (bis ca 100 Texte Jahr) Ansonsten empfiehlt sich eine vollautomatische Integration uumlber die Schnittstellen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 7 von 39
Bearbeitungsstand final
2 Zugriffszaumlhlung Fuumlr die Zugriffszaumlhlung wird das bdquoskalierbare zentrale Messsystemldquo dass auch fuumlr die Werbewirtschaft (IVW) eingesetzt wird verwendet Dabei werden in HTML Seiten unsichtbare Bilder (Zaumlhlmarken) eingebaut die zu Zugriffszaumlhlungen fuumlhren
Die Zugriffszaumlhlung bildet die Basis fuumlr eine moumlgliche Ausschuumlttung Aus diesem Grund muss darauf geachtet werden moumlglichst alle Texte die fuumlr die Ausschuumlttung in Frage kommen zu zaumlhlen
Viele Artikel haben am Erscheinungstag die meisten Zugriffe Achten Sie unbedingt darauf dass Sie die Artikel sofort beim Erscheinen mit einer Zaumlhlmarke versehen da ansonsten moumlglicherweise der festgelegte Mindestzugriff nicht mehr erreicht werden kann
Bei den bisher teilnehmenden Verlagen hat es sich bewaumlhrt als Erstes mit der Zaumlhlung von neu erscheinenden Artikeln zu beginnen Erst sobald das reibungslos automatisiert funktioniert sollte man sich die Frage stellen ob man aumlltere Artikel (zB Archiv hellip) nachtraumlglich mit Zaumlhlmarken ausstatten moumlchte Eine Empfehlung dafuumlr oder dagegen kann man generell nicht aussprechen da es davon abhaumlngt wie stark solche Archivinhalte genutzt werden Das sollte im Verlag anhand von Kosten Nutzen entschieden werden
21 Grundsaumltzliches zu Zaumlhlmarken
211 Zaumlhlmarken der VG WORT
Jede Zaumlhlmarke besteht aus zwei Teilen (oumlffentlicher Identifikationscode privater Identifikationscode) Der oumlf fentliche Identifikationscode dient zum Einbau in die jeweilige HTML ndash Seite (siehe Kapitel 23 Einbau einer Zaumlhlmarke) Der private Identifikationscode wird spaumlter im Rahmen der Meldung benoumltigt
Aus diesem Grund muss der private Identifikationscode in Ihrem CMS System mit dem Artikel verknuumlpft werden
212 Verlagsinterner Schluumlssel als Zaumlhlmarke
In Verlagen werden die Artikel oftmals mit eindeutigen internen Schluumlsseln versehen Diese internen Schluumlssel koumlnnen ebenfalls als Zaumlhlmarke verwendet werden In diesem Fall wird sowohl fuumlr den oumlf fentlichen als auch fuumlr den privaten Identifikationscode der verlagsinterne Schluumlssel verwendet
Dabei gibt es folgendes zu beachten
- Ein verlagsinterner Schluumlssel setzt sich aus dem Praumlfix bdquovgzmltKarteinummergt-ldquo und einen beliebigen Schluumlssel zusammen Der Platzhalter bdquoltKarteinummergtldquo muss mit der VGWORT Karteinummer des Verlags ersetzt werden
- Der Schluumlssel darf keine Sonderzeichen enthalten (dh nur [a-z][A-Z][0-9] sowie den Punkt den Bindestrich und den Unterstrich)
- Der Schluumlssel muss innerhalb vom Verlag eindeutig sein
- DOI (httpwwwdoiorg) koumlnnen ebenfalls als verlagsinterne Schluumlssel zum Einsatz kommen Der Slash nach der Verlagskennung muss durch einen Bindestrich (-) ersetzt werden Es duumlrfen im DOI auch keine weiteren Slashes vorkommen
Beispiel vgzm970-123456789
Bitte setzen Sie sich vor Verwendung von verlagsinternen Schluumlsseln als Zaumlhlmarke unbedingt mit der VG WORT in Verbindung (per Email an metissupportvgwortde) Sie erhalten dann eine Zaumlhldomaumlne die Sie fuumlr den Einbau der Zaumlhlmarken benoumltigen und Sie werden fuumlr die Zugriffszaumlhlung mit verlagsinternen Schluumlsseln freigeschalten Ohne diese Schritte ist keine Zaumlhlung mit verlagsinternen Schluumlsseln moumlglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 4 von 39
Bearbeitungsstand final
332 Uumlber Maske 23
34 Urhebermeldung 24
35 Pruumlfung der Karteinummer 24
351 Web Service Schnittstelle 24
36 Ergaumlnzung gemeldeter Beteiligter 25
361 Meldung uumlber Web Service Schnittstelle 25
362 Uumlber Maske 26
37 Qualitaumltskontrolle 28
371 Uumlber Web Service Schnittstelle 29
372 Uumlber Maske 30
38 Zugangsbeschraumlnkte Texte 30
4 Technische Verfahren Web Services 32
41 Authentifizierung 32
411 Autorisierungs- Authentif izierungsfehler 32
42 Datensicherheit 32
43 Versionierung 32
44 Nachrichten Ablauf 32
45 Testsystem 33
46 Probleme im Umgang mit Apache AXIS (ADB) 33
47 Beispiele fuumlr Web Service Aufrufe 33
471 PixelService 33
472 MessageService 34
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 5 von 39
Bearbeitungsstand final
1 Einleitung Dieses Dokument dient als Beschreibung fuumlr Verlage die am METIS Verfahren teilnehmen wollen Es beinhaltet sowohl die generelle Verfahrensbeschreibung wie auch die technische Beschreibung der eingesetzten Schnittstellen Es basiert auf langjaumlhriger Erfahrung dadurch sind bereits Erfahrungswerte sowie Probleme bei vergangenen Integrationen eingeflossen
Um an METIS teilnehmen zu koumlnnen ist eine einmalige Meldesystemregistrierung unter httptomvgwortde noumltig
11 Voraussetzung fuumlr die Verguumltung von Texten
Bei METIS wird die Zweitverwertung von Texten im Internet verguumltet (dh Kopien die von den im Internet zur Verfuumlgung gestellten Texten angefertigt werden) Aus diesem Grund werden Texte ausgeschlossen die einen technischen Kopierschutz enthalten
Da es nicht moumlglich ist den technischen Kopiervorgang festzustellen trifft die VG WORT die Annahme dass es einen Zusammenhang zwischen der Nutzung und der Zweitverwertung von einem Text gibt Dh man geht davon aus dass Texte die haumlufig gelesen werden auch haumlufig kopiert werden Aus diesem Grund muumlssen die Texte im Rahmen eines Zaumlhlverfahrens individuell gezaumlhlt werden Fuumlr die Ausschuumlttung werden Texte herangezogen deren Zugriffszaumlhlung einen festgelegten Mindestzugriff erreichen Der Mindestzugriff wird von der VG WORT fuumlr ein Kalenderjahr im Januar des Folgejahres im Meldesystem festgelegt Fuumlr das Jahr 2014 musste ein Text mit einer Laumlnge unter 10000 Zeichen 1500 Visits Jahr erreichen Bei einer Textlaumlnge von zumindest 10000 Zeichen hat sich der Mindestzugriff auf 750 Visits Jahr reduziert (Anteiliger Mindestzugriff) Zaumlhlungen von Texten hinter Bezahlschranken werden ab dem Jahr 2016 mit Faktor 3 multipliziert Weiterfuumlhrende Informationen finden Sie auf der Homepage der VG WORT
- Verteilungsplan httpwwwvgwortdepublikationen-dokumenteverteilungsplaenehtml (sect 58 und sect 59)
- Quoten httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Kapitel bdquoMETISldquo)
Ein weiteres Kriterium betrifft die Textlaumlnge Die Texte muumlssen eine Mindestlaumlnge von 1800 Zeichen (inkl Leerzeichen) erreichen Die Ausnahme bilden Gedichte ndash diese koumlnnen auch kuumlrzer sein
Zusammenfassung der Kriterien - Text muss im Internet veroumlffentlicht sein - Kein Kopierschutz (hartes DRM) - Mindestlaumlnge 1800 Zeichen (ausgenommen Lyrik) - Der festgelegte Mindestzugriff muss erreicht werden
12 Houmlhe der Tantieme
Die Houmlhe der Tantieme wird von der VG WORT fuumlr ein Kalenderjahr im Nachhinein (Mai Juni) festgelegt Die Tantieme besteht aus einem Verlagsanteil und einem Autorenanteil Die aktuellen Tantiemen und Modalitaumlten finden Sie in der Quotenuumlbersicht auf der Homepage der VG WORT unter httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Abschnitt bdquoMETISldquo)
Zu beachten ist dass die Houmlhe der Tantieme pro Text angegeben ist der die oben genannten Voraussetzungen erfuumlllt Dadurch sollten sich bei Verlagen die pro Jahr einige hundert oder tausend solcher Texte veroumlffentlichen die Investitionskosten rasch amortisieren
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 6 von 39
Bearbeitungsstand final
13 Uumlberblick Ablauf
Um eine Tantieme zu erhalten sind pro Text nur drei Schritte noumltig
1) Zugriffszaumlhlung
2) Meldung uumlbermitteln
3) Ausschuumlttung erhalten
Die Grundlage fuumlr die Ausschuumlttung bilden die Zugriffszahlen daher ist es wichtig so schnell und so vollstaumlndig wie moumlglich mit der Zugriffszaumlhlung zu beginnen (siehe Kapitel bdquo2 Zugriffszaumlhlungldquo) Fuumlr eine spaumltere Meldung muss die dabei vergebene Zaumlhlmarke intern mit dem Text verknuumlpft werden Jeder Text muss dabei mit einer eigenen Zaumlhlmarke versehen werden
Der zweite Schritt ist die Uumlbermittlung der Meldung (siehe Kapitel bdquo3 Meldungldquo) Dabei wird der Text die Veroumlffentlichungsorte (URLs) sowie alle beteiligten Autoren und Uumlbersetzer an die VG WORT gemeldet
Nach Erstellung der Meldung pruumlft die VG WORT bei jedem Text ob er den Kriterien fuumlr die Ausschuumlttung entspricht Ist das der Fall erfolgt automatisch die Ausschuumlttung
14 Technische Grundlagen
Jeder beschriebene Schritt laumlsst sich manuell uumlber Meldemasken oder automatisiert uumlber Web Service Schnittstellen bedienen Die manuelle Variante ist fuumlr kleinere Verlage empfohlen (bis ca 100 Texte Jahr) Ansonsten empfiehlt sich eine vollautomatische Integration uumlber die Schnittstellen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 7 von 39
Bearbeitungsstand final
2 Zugriffszaumlhlung Fuumlr die Zugriffszaumlhlung wird das bdquoskalierbare zentrale Messsystemldquo dass auch fuumlr die Werbewirtschaft (IVW) eingesetzt wird verwendet Dabei werden in HTML Seiten unsichtbare Bilder (Zaumlhlmarken) eingebaut die zu Zugriffszaumlhlungen fuumlhren
Die Zugriffszaumlhlung bildet die Basis fuumlr eine moumlgliche Ausschuumlttung Aus diesem Grund muss darauf geachtet werden moumlglichst alle Texte die fuumlr die Ausschuumlttung in Frage kommen zu zaumlhlen
Viele Artikel haben am Erscheinungstag die meisten Zugriffe Achten Sie unbedingt darauf dass Sie die Artikel sofort beim Erscheinen mit einer Zaumlhlmarke versehen da ansonsten moumlglicherweise der festgelegte Mindestzugriff nicht mehr erreicht werden kann
Bei den bisher teilnehmenden Verlagen hat es sich bewaumlhrt als Erstes mit der Zaumlhlung von neu erscheinenden Artikeln zu beginnen Erst sobald das reibungslos automatisiert funktioniert sollte man sich die Frage stellen ob man aumlltere Artikel (zB Archiv hellip) nachtraumlglich mit Zaumlhlmarken ausstatten moumlchte Eine Empfehlung dafuumlr oder dagegen kann man generell nicht aussprechen da es davon abhaumlngt wie stark solche Archivinhalte genutzt werden Das sollte im Verlag anhand von Kosten Nutzen entschieden werden
21 Grundsaumltzliches zu Zaumlhlmarken
211 Zaumlhlmarken der VG WORT
Jede Zaumlhlmarke besteht aus zwei Teilen (oumlffentlicher Identifikationscode privater Identifikationscode) Der oumlf fentliche Identifikationscode dient zum Einbau in die jeweilige HTML ndash Seite (siehe Kapitel 23 Einbau einer Zaumlhlmarke) Der private Identifikationscode wird spaumlter im Rahmen der Meldung benoumltigt
Aus diesem Grund muss der private Identifikationscode in Ihrem CMS System mit dem Artikel verknuumlpft werden
212 Verlagsinterner Schluumlssel als Zaumlhlmarke
In Verlagen werden die Artikel oftmals mit eindeutigen internen Schluumlsseln versehen Diese internen Schluumlssel koumlnnen ebenfalls als Zaumlhlmarke verwendet werden In diesem Fall wird sowohl fuumlr den oumlf fentlichen als auch fuumlr den privaten Identifikationscode der verlagsinterne Schluumlssel verwendet
Dabei gibt es folgendes zu beachten
- Ein verlagsinterner Schluumlssel setzt sich aus dem Praumlfix bdquovgzmltKarteinummergt-ldquo und einen beliebigen Schluumlssel zusammen Der Platzhalter bdquoltKarteinummergtldquo muss mit der VGWORT Karteinummer des Verlags ersetzt werden
- Der Schluumlssel darf keine Sonderzeichen enthalten (dh nur [a-z][A-Z][0-9] sowie den Punkt den Bindestrich und den Unterstrich)
- Der Schluumlssel muss innerhalb vom Verlag eindeutig sein
- DOI (httpwwwdoiorg) koumlnnen ebenfalls als verlagsinterne Schluumlssel zum Einsatz kommen Der Slash nach der Verlagskennung muss durch einen Bindestrich (-) ersetzt werden Es duumlrfen im DOI auch keine weiteren Slashes vorkommen
Beispiel vgzm970-123456789
Bitte setzen Sie sich vor Verwendung von verlagsinternen Schluumlsseln als Zaumlhlmarke unbedingt mit der VG WORT in Verbindung (per Email an metissupportvgwortde) Sie erhalten dann eine Zaumlhldomaumlne die Sie fuumlr den Einbau der Zaumlhlmarken benoumltigen und Sie werden fuumlr die Zugriffszaumlhlung mit verlagsinternen Schluumlsseln freigeschalten Ohne diese Schritte ist keine Zaumlhlung mit verlagsinternen Schluumlsseln moumlglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 5 von 39
Bearbeitungsstand final
1 Einleitung Dieses Dokument dient als Beschreibung fuumlr Verlage die am METIS Verfahren teilnehmen wollen Es beinhaltet sowohl die generelle Verfahrensbeschreibung wie auch die technische Beschreibung der eingesetzten Schnittstellen Es basiert auf langjaumlhriger Erfahrung dadurch sind bereits Erfahrungswerte sowie Probleme bei vergangenen Integrationen eingeflossen
Um an METIS teilnehmen zu koumlnnen ist eine einmalige Meldesystemregistrierung unter httptomvgwortde noumltig
11 Voraussetzung fuumlr die Verguumltung von Texten
Bei METIS wird die Zweitverwertung von Texten im Internet verguumltet (dh Kopien die von den im Internet zur Verfuumlgung gestellten Texten angefertigt werden) Aus diesem Grund werden Texte ausgeschlossen die einen technischen Kopierschutz enthalten
Da es nicht moumlglich ist den technischen Kopiervorgang festzustellen trifft die VG WORT die Annahme dass es einen Zusammenhang zwischen der Nutzung und der Zweitverwertung von einem Text gibt Dh man geht davon aus dass Texte die haumlufig gelesen werden auch haumlufig kopiert werden Aus diesem Grund muumlssen die Texte im Rahmen eines Zaumlhlverfahrens individuell gezaumlhlt werden Fuumlr die Ausschuumlttung werden Texte herangezogen deren Zugriffszaumlhlung einen festgelegten Mindestzugriff erreichen Der Mindestzugriff wird von der VG WORT fuumlr ein Kalenderjahr im Januar des Folgejahres im Meldesystem festgelegt Fuumlr das Jahr 2014 musste ein Text mit einer Laumlnge unter 10000 Zeichen 1500 Visits Jahr erreichen Bei einer Textlaumlnge von zumindest 10000 Zeichen hat sich der Mindestzugriff auf 750 Visits Jahr reduziert (Anteiliger Mindestzugriff) Zaumlhlungen von Texten hinter Bezahlschranken werden ab dem Jahr 2016 mit Faktor 3 multipliziert Weiterfuumlhrende Informationen finden Sie auf der Homepage der VG WORT
- Verteilungsplan httpwwwvgwortdepublikationen-dokumenteverteilungsplaenehtml (sect 58 und sect 59)
- Quoten httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Kapitel bdquoMETISldquo)
Ein weiteres Kriterium betrifft die Textlaumlnge Die Texte muumlssen eine Mindestlaumlnge von 1800 Zeichen (inkl Leerzeichen) erreichen Die Ausnahme bilden Gedichte ndash diese koumlnnen auch kuumlrzer sein
Zusammenfassung der Kriterien - Text muss im Internet veroumlffentlicht sein - Kein Kopierschutz (hartes DRM) - Mindestlaumlnge 1800 Zeichen (ausgenommen Lyrik) - Der festgelegte Mindestzugriff muss erreicht werden
12 Houmlhe der Tantieme
Die Houmlhe der Tantieme wird von der VG WORT fuumlr ein Kalenderjahr im Nachhinein (Mai Juni) festgelegt Die Tantieme besteht aus einem Verlagsanteil und einem Autorenanteil Die aktuellen Tantiemen und Modalitaumlten finden Sie in der Quotenuumlbersicht auf der Homepage der VG WORT unter httpwwwvgwortdepublikationen-dokumentequoten-uebersichthtml (Abschnitt bdquoMETISldquo)
Zu beachten ist dass die Houmlhe der Tantieme pro Text angegeben ist der die oben genannten Voraussetzungen erfuumlllt Dadurch sollten sich bei Verlagen die pro Jahr einige hundert oder tausend solcher Texte veroumlffentlichen die Investitionskosten rasch amortisieren
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 6 von 39
Bearbeitungsstand final
13 Uumlberblick Ablauf
Um eine Tantieme zu erhalten sind pro Text nur drei Schritte noumltig
1) Zugriffszaumlhlung
2) Meldung uumlbermitteln
3) Ausschuumlttung erhalten
Die Grundlage fuumlr die Ausschuumlttung bilden die Zugriffszahlen daher ist es wichtig so schnell und so vollstaumlndig wie moumlglich mit der Zugriffszaumlhlung zu beginnen (siehe Kapitel bdquo2 Zugriffszaumlhlungldquo) Fuumlr eine spaumltere Meldung muss die dabei vergebene Zaumlhlmarke intern mit dem Text verknuumlpft werden Jeder Text muss dabei mit einer eigenen Zaumlhlmarke versehen werden
Der zweite Schritt ist die Uumlbermittlung der Meldung (siehe Kapitel bdquo3 Meldungldquo) Dabei wird der Text die Veroumlffentlichungsorte (URLs) sowie alle beteiligten Autoren und Uumlbersetzer an die VG WORT gemeldet
Nach Erstellung der Meldung pruumlft die VG WORT bei jedem Text ob er den Kriterien fuumlr die Ausschuumlttung entspricht Ist das der Fall erfolgt automatisch die Ausschuumlttung
14 Technische Grundlagen
Jeder beschriebene Schritt laumlsst sich manuell uumlber Meldemasken oder automatisiert uumlber Web Service Schnittstellen bedienen Die manuelle Variante ist fuumlr kleinere Verlage empfohlen (bis ca 100 Texte Jahr) Ansonsten empfiehlt sich eine vollautomatische Integration uumlber die Schnittstellen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 7 von 39
Bearbeitungsstand final
2 Zugriffszaumlhlung Fuumlr die Zugriffszaumlhlung wird das bdquoskalierbare zentrale Messsystemldquo dass auch fuumlr die Werbewirtschaft (IVW) eingesetzt wird verwendet Dabei werden in HTML Seiten unsichtbare Bilder (Zaumlhlmarken) eingebaut die zu Zugriffszaumlhlungen fuumlhren
Die Zugriffszaumlhlung bildet die Basis fuumlr eine moumlgliche Ausschuumlttung Aus diesem Grund muss darauf geachtet werden moumlglichst alle Texte die fuumlr die Ausschuumlttung in Frage kommen zu zaumlhlen
Viele Artikel haben am Erscheinungstag die meisten Zugriffe Achten Sie unbedingt darauf dass Sie die Artikel sofort beim Erscheinen mit einer Zaumlhlmarke versehen da ansonsten moumlglicherweise der festgelegte Mindestzugriff nicht mehr erreicht werden kann
Bei den bisher teilnehmenden Verlagen hat es sich bewaumlhrt als Erstes mit der Zaumlhlung von neu erscheinenden Artikeln zu beginnen Erst sobald das reibungslos automatisiert funktioniert sollte man sich die Frage stellen ob man aumlltere Artikel (zB Archiv hellip) nachtraumlglich mit Zaumlhlmarken ausstatten moumlchte Eine Empfehlung dafuumlr oder dagegen kann man generell nicht aussprechen da es davon abhaumlngt wie stark solche Archivinhalte genutzt werden Das sollte im Verlag anhand von Kosten Nutzen entschieden werden
21 Grundsaumltzliches zu Zaumlhlmarken
211 Zaumlhlmarken der VG WORT
Jede Zaumlhlmarke besteht aus zwei Teilen (oumlffentlicher Identifikationscode privater Identifikationscode) Der oumlf fentliche Identifikationscode dient zum Einbau in die jeweilige HTML ndash Seite (siehe Kapitel 23 Einbau einer Zaumlhlmarke) Der private Identifikationscode wird spaumlter im Rahmen der Meldung benoumltigt
Aus diesem Grund muss der private Identifikationscode in Ihrem CMS System mit dem Artikel verknuumlpft werden
212 Verlagsinterner Schluumlssel als Zaumlhlmarke
In Verlagen werden die Artikel oftmals mit eindeutigen internen Schluumlsseln versehen Diese internen Schluumlssel koumlnnen ebenfalls als Zaumlhlmarke verwendet werden In diesem Fall wird sowohl fuumlr den oumlf fentlichen als auch fuumlr den privaten Identifikationscode der verlagsinterne Schluumlssel verwendet
Dabei gibt es folgendes zu beachten
- Ein verlagsinterner Schluumlssel setzt sich aus dem Praumlfix bdquovgzmltKarteinummergt-ldquo und einen beliebigen Schluumlssel zusammen Der Platzhalter bdquoltKarteinummergtldquo muss mit der VGWORT Karteinummer des Verlags ersetzt werden
- Der Schluumlssel darf keine Sonderzeichen enthalten (dh nur [a-z][A-Z][0-9] sowie den Punkt den Bindestrich und den Unterstrich)
- Der Schluumlssel muss innerhalb vom Verlag eindeutig sein
- DOI (httpwwwdoiorg) koumlnnen ebenfalls als verlagsinterne Schluumlssel zum Einsatz kommen Der Slash nach der Verlagskennung muss durch einen Bindestrich (-) ersetzt werden Es duumlrfen im DOI auch keine weiteren Slashes vorkommen
Beispiel vgzm970-123456789
Bitte setzen Sie sich vor Verwendung von verlagsinternen Schluumlsseln als Zaumlhlmarke unbedingt mit der VG WORT in Verbindung (per Email an metissupportvgwortde) Sie erhalten dann eine Zaumlhldomaumlne die Sie fuumlr den Einbau der Zaumlhlmarken benoumltigen und Sie werden fuumlr die Zugriffszaumlhlung mit verlagsinternen Schluumlsseln freigeschalten Ohne diese Schritte ist keine Zaumlhlung mit verlagsinternen Schluumlsseln moumlglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 6 von 39
Bearbeitungsstand final
13 Uumlberblick Ablauf
Um eine Tantieme zu erhalten sind pro Text nur drei Schritte noumltig
1) Zugriffszaumlhlung
2) Meldung uumlbermitteln
3) Ausschuumlttung erhalten
Die Grundlage fuumlr die Ausschuumlttung bilden die Zugriffszahlen daher ist es wichtig so schnell und so vollstaumlndig wie moumlglich mit der Zugriffszaumlhlung zu beginnen (siehe Kapitel bdquo2 Zugriffszaumlhlungldquo) Fuumlr eine spaumltere Meldung muss die dabei vergebene Zaumlhlmarke intern mit dem Text verknuumlpft werden Jeder Text muss dabei mit einer eigenen Zaumlhlmarke versehen werden
Der zweite Schritt ist die Uumlbermittlung der Meldung (siehe Kapitel bdquo3 Meldungldquo) Dabei wird der Text die Veroumlffentlichungsorte (URLs) sowie alle beteiligten Autoren und Uumlbersetzer an die VG WORT gemeldet
Nach Erstellung der Meldung pruumlft die VG WORT bei jedem Text ob er den Kriterien fuumlr die Ausschuumlttung entspricht Ist das der Fall erfolgt automatisch die Ausschuumlttung
14 Technische Grundlagen
Jeder beschriebene Schritt laumlsst sich manuell uumlber Meldemasken oder automatisiert uumlber Web Service Schnittstellen bedienen Die manuelle Variante ist fuumlr kleinere Verlage empfohlen (bis ca 100 Texte Jahr) Ansonsten empfiehlt sich eine vollautomatische Integration uumlber die Schnittstellen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 7 von 39
Bearbeitungsstand final
2 Zugriffszaumlhlung Fuumlr die Zugriffszaumlhlung wird das bdquoskalierbare zentrale Messsystemldquo dass auch fuumlr die Werbewirtschaft (IVW) eingesetzt wird verwendet Dabei werden in HTML Seiten unsichtbare Bilder (Zaumlhlmarken) eingebaut die zu Zugriffszaumlhlungen fuumlhren
Die Zugriffszaumlhlung bildet die Basis fuumlr eine moumlgliche Ausschuumlttung Aus diesem Grund muss darauf geachtet werden moumlglichst alle Texte die fuumlr die Ausschuumlttung in Frage kommen zu zaumlhlen
Viele Artikel haben am Erscheinungstag die meisten Zugriffe Achten Sie unbedingt darauf dass Sie die Artikel sofort beim Erscheinen mit einer Zaumlhlmarke versehen da ansonsten moumlglicherweise der festgelegte Mindestzugriff nicht mehr erreicht werden kann
Bei den bisher teilnehmenden Verlagen hat es sich bewaumlhrt als Erstes mit der Zaumlhlung von neu erscheinenden Artikeln zu beginnen Erst sobald das reibungslos automatisiert funktioniert sollte man sich die Frage stellen ob man aumlltere Artikel (zB Archiv hellip) nachtraumlglich mit Zaumlhlmarken ausstatten moumlchte Eine Empfehlung dafuumlr oder dagegen kann man generell nicht aussprechen da es davon abhaumlngt wie stark solche Archivinhalte genutzt werden Das sollte im Verlag anhand von Kosten Nutzen entschieden werden
21 Grundsaumltzliches zu Zaumlhlmarken
211 Zaumlhlmarken der VG WORT
Jede Zaumlhlmarke besteht aus zwei Teilen (oumlffentlicher Identifikationscode privater Identifikationscode) Der oumlf fentliche Identifikationscode dient zum Einbau in die jeweilige HTML ndash Seite (siehe Kapitel 23 Einbau einer Zaumlhlmarke) Der private Identifikationscode wird spaumlter im Rahmen der Meldung benoumltigt
Aus diesem Grund muss der private Identifikationscode in Ihrem CMS System mit dem Artikel verknuumlpft werden
212 Verlagsinterner Schluumlssel als Zaumlhlmarke
In Verlagen werden die Artikel oftmals mit eindeutigen internen Schluumlsseln versehen Diese internen Schluumlssel koumlnnen ebenfalls als Zaumlhlmarke verwendet werden In diesem Fall wird sowohl fuumlr den oumlf fentlichen als auch fuumlr den privaten Identifikationscode der verlagsinterne Schluumlssel verwendet
Dabei gibt es folgendes zu beachten
- Ein verlagsinterner Schluumlssel setzt sich aus dem Praumlfix bdquovgzmltKarteinummergt-ldquo und einen beliebigen Schluumlssel zusammen Der Platzhalter bdquoltKarteinummergtldquo muss mit der VGWORT Karteinummer des Verlags ersetzt werden
- Der Schluumlssel darf keine Sonderzeichen enthalten (dh nur [a-z][A-Z][0-9] sowie den Punkt den Bindestrich und den Unterstrich)
- Der Schluumlssel muss innerhalb vom Verlag eindeutig sein
- DOI (httpwwwdoiorg) koumlnnen ebenfalls als verlagsinterne Schluumlssel zum Einsatz kommen Der Slash nach der Verlagskennung muss durch einen Bindestrich (-) ersetzt werden Es duumlrfen im DOI auch keine weiteren Slashes vorkommen
Beispiel vgzm970-123456789
Bitte setzen Sie sich vor Verwendung von verlagsinternen Schluumlsseln als Zaumlhlmarke unbedingt mit der VG WORT in Verbindung (per Email an metissupportvgwortde) Sie erhalten dann eine Zaumlhldomaumlne die Sie fuumlr den Einbau der Zaumlhlmarken benoumltigen und Sie werden fuumlr die Zugriffszaumlhlung mit verlagsinternen Schluumlsseln freigeschalten Ohne diese Schritte ist keine Zaumlhlung mit verlagsinternen Schluumlsseln moumlglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 7 von 39
Bearbeitungsstand final
2 Zugriffszaumlhlung Fuumlr die Zugriffszaumlhlung wird das bdquoskalierbare zentrale Messsystemldquo dass auch fuumlr die Werbewirtschaft (IVW) eingesetzt wird verwendet Dabei werden in HTML Seiten unsichtbare Bilder (Zaumlhlmarken) eingebaut die zu Zugriffszaumlhlungen fuumlhren
Die Zugriffszaumlhlung bildet die Basis fuumlr eine moumlgliche Ausschuumlttung Aus diesem Grund muss darauf geachtet werden moumlglichst alle Texte die fuumlr die Ausschuumlttung in Frage kommen zu zaumlhlen
Viele Artikel haben am Erscheinungstag die meisten Zugriffe Achten Sie unbedingt darauf dass Sie die Artikel sofort beim Erscheinen mit einer Zaumlhlmarke versehen da ansonsten moumlglicherweise der festgelegte Mindestzugriff nicht mehr erreicht werden kann
Bei den bisher teilnehmenden Verlagen hat es sich bewaumlhrt als Erstes mit der Zaumlhlung von neu erscheinenden Artikeln zu beginnen Erst sobald das reibungslos automatisiert funktioniert sollte man sich die Frage stellen ob man aumlltere Artikel (zB Archiv hellip) nachtraumlglich mit Zaumlhlmarken ausstatten moumlchte Eine Empfehlung dafuumlr oder dagegen kann man generell nicht aussprechen da es davon abhaumlngt wie stark solche Archivinhalte genutzt werden Das sollte im Verlag anhand von Kosten Nutzen entschieden werden
21 Grundsaumltzliches zu Zaumlhlmarken
211 Zaumlhlmarken der VG WORT
Jede Zaumlhlmarke besteht aus zwei Teilen (oumlffentlicher Identifikationscode privater Identifikationscode) Der oumlf fentliche Identifikationscode dient zum Einbau in die jeweilige HTML ndash Seite (siehe Kapitel 23 Einbau einer Zaumlhlmarke) Der private Identifikationscode wird spaumlter im Rahmen der Meldung benoumltigt
Aus diesem Grund muss der private Identifikationscode in Ihrem CMS System mit dem Artikel verknuumlpft werden
212 Verlagsinterner Schluumlssel als Zaumlhlmarke
In Verlagen werden die Artikel oftmals mit eindeutigen internen Schluumlsseln versehen Diese internen Schluumlssel koumlnnen ebenfalls als Zaumlhlmarke verwendet werden In diesem Fall wird sowohl fuumlr den oumlf fentlichen als auch fuumlr den privaten Identifikationscode der verlagsinterne Schluumlssel verwendet
Dabei gibt es folgendes zu beachten
- Ein verlagsinterner Schluumlssel setzt sich aus dem Praumlfix bdquovgzmltKarteinummergt-ldquo und einen beliebigen Schluumlssel zusammen Der Platzhalter bdquoltKarteinummergtldquo muss mit der VGWORT Karteinummer des Verlags ersetzt werden
- Der Schluumlssel darf keine Sonderzeichen enthalten (dh nur [a-z][A-Z][0-9] sowie den Punkt den Bindestrich und den Unterstrich)
- Der Schluumlssel muss innerhalb vom Verlag eindeutig sein
- DOI (httpwwwdoiorg) koumlnnen ebenfalls als verlagsinterne Schluumlssel zum Einsatz kommen Der Slash nach der Verlagskennung muss durch einen Bindestrich (-) ersetzt werden Es duumlrfen im DOI auch keine weiteren Slashes vorkommen
Beispiel vgzm970-123456789
Bitte setzen Sie sich vor Verwendung von verlagsinternen Schluumlsseln als Zaumlhlmarke unbedingt mit der VG WORT in Verbindung (per Email an metissupportvgwortde) Sie erhalten dann eine Zaumlhldomaumlne die Sie fuumlr den Einbau der Zaumlhlmarken benoumltigen und Sie werden fuumlr die Zugriffszaumlhlung mit verlagsinternen Schluumlsseln freigeschalten Ohne diese Schritte ist keine Zaumlhlung mit verlagsinternen Schluumlsseln moumlglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 8 von 39
Bearbeitungsstand final
213 Allgemein
Es empfiehlt sich zuerst die Zugriffszaumlhlung umzusetzen und erst dann die Meldung (siehe Kapitel 3) zu implementieren
Zum Zeitpunkt der Zugriffszaumlhlung muumlssen noch nicht alle Informationen zum Text (zB Autoreninformation) vorliegen Daher soll die Umsetzung der Zugriffszaumlhlung auf keinen Fall von solchen Faktoren abhaumlngen
214 Datenschutzerklaumlrung
Im Rahmen der Zugriffszaumlhlung werden Cookies und gegebenenfalls JavaScript - Aufrufe verwendet Es empfiehlt sich daher die Datenschutzerklaumlrung der Verlagsseite in der Zaumlhlmarken eingebaut werden um unten stehende Textbausteine zu ergaumlnzen
Cookies und Meldungen zu Zugriffszahlen
Wir setzen Session-Cookies der VG Wort Muumlnchen zur Messung von Zugriffen auf Texten ein um die Kopierwahrscheinlichkeit zu erfassen Session-Cookies sind kleine Informationseinheiten die ein Anbieter im Arbeitsspeicher des Computers des Besuchers speichert In einem Session-Cook ie wird eine zufaumlllig erzeugte eindeutige Identif ikationsnummer abgelegt eine sogenannte Session-ID Auszligerdem enthaumllt ein Cookie die Angabe uumlber seine Herkunft und die Speicherfrist Session-Cookies koumlnnen keine anderen Daten speichern Diese Messungen werden von der Kantar Germany GmbH nach dem Skalierbaren Zentralen Messverfahren (SZM) durchgefuumlhrt Sie helfen dabei die Kopierwahrscheinlichkeit einzelner Texte zur Verguumltung von gesetzlichen Anspruumlchen von Autoren und Verlagen zu ermitteln Wir erfassen keine personenbezogenen Daten uumlber Cookies
Viele unserer Seiten sind mit JavaScript-Aufrufen versehen uumlber die wir die Zugrif fe an die Verwertungsgesellschaft Wort (VG Wort) melden [BITTE UumlBERPRUumlFEN ob dies bei Ihrem Verlag der Fall ist] Wir ermoumlglichen damit dass unsere Autoren an den Ausschuumlttungen der VG Wort partizipieren die die gesetzliche Verguumltung fuumlr die Nutzungen urheberrechtlich geschuumltzter Werke gem sect 53 UrhG sicherstellen
Eine Nutzung unserer Angebote ist auch ohne Cookies moumlglich Die meisten Browser sind so eingestellt dass sie Cookies automatisch akzeptieren Sie koumlnnen das Speichern von Cookies jedoch deaktivieren oder Ihren Browser so einstellen dass er Sie benachrichtigt sobald Cookies gesendet werden
Datenschutzerklaumlrung zur Nutzung des Skalierbaren Zentralen Messverfahrens
Webangebote
Unsere Website und unser mobiles Webangebot nutzen das bdquoSkalierbare Zent rale Messverfahrenldquo (SZM) der Kantar Germany GmbH fuumlr die Ermittlung statistischer Kennwerte zur Ermittlung der Kopierwahrscheinlichkeit von Texten
Dabei werden anonyme Messwerte erhoben Die Zugrif fszahlenmessung verwendet zur Wiedererkennung von Computersystemen alternativ ein Session-Cookie oder eine Signatur die aus verschiedenen automatisch uumlbertragenen Informationen Ihres Browsers ers tel l t wird IP-Adressen werden nur in anonymisierter Form verarbeitet
Das Verfahren wurde unter der Beachtung des Datenschutzes entwickelt Einziges Ziel des Verfahrens ist es die Kopierwahrscheinlichkeit einzelner Texte zu ermitteln
Zu keinem Zeitpunkt werden einzelne Nutzer identifiziert Ihre Identitaumlt bleibt immer geschuumltzt Sie erhalten uumlber das System keine Werbung
22 Bestellen von Zaumlhlmarken
Verlage haben den Bedarf groszlige Mengen von Zaumlhlmarken auf einmal abzurufen um diese dann in den internen CMS Systemen vorraumltig zu halten Hierfuumlr gibt es zwei Varianten Eine Variante ist es die Zaumlhlmarken direkt aus dem Portal abzurufen bei der anderen Variante erfolgt der Abruf uumlber ein Web Service und kann so automatisiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 9 von 39
Bearbeitungsstand final
Grundsaumltzlich koumlnnen pro Jahr 4000 Zaumlhlmarken abgerufen werden Sollte ein Verlag mehr Zaumlhlmarken benoumltigen wird er gebeten sich per Email an metissupportvgwortde zu wenden damit die noumltigen Kapazitaumlten zur Verfuumlgung gestellt werden koumlnnen
Es empfiehlt sich immer einen Zaumlhlmarkenvorrat fuumlr zumindest eine Woche vorraumlt ig zu halten um nicht von der Verfuumlgbarkeit der METIS Anwendung abhaumlngig zu sein
Beim Einsatz von verlagsinternen Schluumlsseln als Zaumlhlmarken entfaumlllt die Bestellung der VG WORT Zaumlhlmarken
221 Bestellung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2211 orderPixelRequest
Feld Typ Beschreibung
count int Anzahl der zu bestellenden Zaumlhlmarken (gt1)
2212 orderPixelResponse
Feld Typ Beschreibung
orderDateTime string Bestelldatum + Zeit im Format bdquoYYYYMMddHHmmldquo
domain string Die Zaumlhlmarken Domaumlne Diese Domaumlne muss beim
Einbau dieser Zaumlhlmarken verwendet werden
pixels pixels Komplexer Datentyp
pixelspublicIdentificationId pixelIDType Oumlffentlicher Identifikationscode der Zaumlhlmarke
pixelsprivateIdentificationId pixelIDType Privater Identifikationscode der Zaumlhlmarke
2213 orderPixelFault
Feld Typ Beschreibung
errorcode int Der Fehlercode
errormsg string Grund fuumlr den Bestellabbruch
maxOrder Int Die maximale Anzahl die fuumlr die jeweilige Bestellung moumlglich gewesen
waumlre (wird nur bei Fehlercode bdquo1ldquo oder Fehlercode bdquo2ldquo angegeben)
22131 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
MaxAnzahlBestellung 1 Die maximale Anzahl () an Zaumlhlmarken fuumlr diese
Bestellung wurde um uumlberschritten
MaxAnzahlJahr 2 Die maximale Anzahl () an Zaumlhlmarken fuumlr das
Jahr wurde um uumlberschritten
KeineEMailVorhanden 3 0 Es existiert keine Email-Adresse in Ihrem
Benutzerkonto bitte tragen Sie diese im Meldeportal
nach
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 10 von 39
Bearbeitungsstand final
Vor allem bei der Bestellung uumlber die Web Service Schnittstelle empfiehlt es s ich einen Zaumlhlmarkenvorrat vorzuhalten (siehe oben)
222 Bestellung uumlber Masken im Meldesystem
Die Bestellung erfolgt nach Einloggen im Portal uumlber den Menuumlpunkt bdquoZaumlhlmarkenbestellungldquo
Abbildung 1 Maskenbeschreibung Zaumlhlmarken Bestellung
Nach Eingabe der benoumltigten Zaumlhlmarken und Klicken auf die Schaltflaumlche bdquoZaumlhlmarken bestellenldquo werden die Zaumlhlmarken vom System generiert Danach wird die Seite zum Download der eben bestellten Zaumlhlmarken angezeigt Falls mehr Zaumlhlmarken bestellt wurden als noch zur Verfuumlgung stehen kommt eine entsprechende Fehlermeldung In diesem Fall wenden Sie sich bitte per Email an metissupportvgwortde
Abbildung 2 Maskenbeschreibung Download der generierten Zaumlhlmarken
In der oben stehenden Maske befindet sich neben der Zaumlhldomaumlne auch Einbaubeispiele fuumlr HTML Texte Beim Klicken auf bdquoDownload der reinen Codepaare als CSV-Dateildquo koumlnnen die bestellten Zaumlhlmarken heruntergeladen werden Das Format der CSV Datei ist im folgenden Abschnitt beschrieben Beim Klicken auf bdquoDownload der vorkonfigurierten Zaumlhlmarken als CSV-Dateildquo wird eine Datei ausgegeben die alle Zaumlhlmarken als fertigen HTML Code enthaumllt
2221 CSV-Datei Format
Die CSV-Datei wird im folgenden Format erstellt (Die Spalten werden durch ein Semikolon getrennt)
Oumlf fentlicher Identifikationscode Privater Identifikationscode
c5b7568d28884052a9ff92d5afd08f34 963d3844c1fe4a2988ab2f6e44fa8221
2dc903d7411841f48c4b65c95f730bed 8741189a4c204f63b24fcff89456fbbf
f5584e4754f741ebb38b2ab9c30c4a0b e2a29638e704455e89a7cfc9dfded134
f42a5ca04bbf4b5c82a43c039e86d6e0 7e9d197b7d1e4ccca9891dbe6ac1a056
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 11 von 39
Bearbeitungsstand final
23 Einbau einer Zaumlhlmarke
231 Fuumlr HTML Texte
Die Zaumlhlmarke ist ein transparentes (unsichtbares) Bild mit der Groumlszlige von 1 x 1 Pixel Es hat keinesfalls Einfluss auf die Ladezeit der Seite da Bilder von den Browsern separat zum Text geladen werden Das unsichtbare Bild hat auch keinen Einfluss auf das Erscheinungsbild der Seite
Einbaubeispiel VG WORT Zaumlhlmarke in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-1234567890 height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel VG WORT Zaumlhlmarke in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenac5b7568d28884052a9ff92d5afd08f34
height=1 width=1 border=ldquo0ldquogt
Einbaubeispiel verlagsinterner Schluumlssel in XHTML (irgendwo zwischen ltbodygt und ltbodygt)
ltIMG src=httpdomainmetvgwortdenavgzm970-123456789 height=1 width=1 border=ldquo0ldquogt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquoc5b7568d28884052a9ff92d5afd08f34rdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquovgzm970-123456789rdquo
Der korrekt formatierte verlagsinterne Schluumlssel des zu zaumlhlenden Textes
232 Fuumlr Dokumente (PDF oder EPUB Dateien)
Eine Zaumlhlmarke kann nicht direkt in eine dieser Dateien eingebaut werden Sie muss daher in die HTML Seite eingebaut werden von der aus das Dokument verlinkt wird Verlinkungen von anderen Seiten koumlnnen nicht beruumlcksichtigt werden Da eine Weiterleitung vom Zaumlhlserver auf externe Dateien aus sicherheitstechnischen Gruumlnden nicht angeboten werden kann benoumltigt man JavaScript um die Zugriffe auf eine PDF Datei zaumlhlen zu koumlnnen
In diesem Fall wird das Zaumlhlpixel (unsichtbare Bild) uumlber JavaScript in die HTML Seite eingefuumlgt sobald das Dokument (der Link auf das Dokument bleibt unveraumlndert) abgerufen wird
Einbaubeispiel HTML (VG WORT Zaumlhlmarke)
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdena98380ae3fc0a4daf84d6197274add99e
width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielepubrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 12 von 39
Bearbeitungsstand final
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
- ldquohttpdomainmetvgwortderdquo
Die Zaumlhldomaumlne Diese muss durch die bei der Bestellung der Zaumlhlmarken erhaltenen Zaumlhldomaumlne ersetzt werden
- ldquonardquo
Fixer Bestandteil der Zaumlhlmarke Darf nicht weggelassen werden
- ldquo98380ae3fc0a4daf84d6197274add99erdquo
Der bdquooumlf fentliche Identifikationscodeldquo der Zaumlhlmarke
- ldquohttpwwwstepscondebeispielepubrdquo
Der Link auf das zu zaumlhlende Dokument
- LINK-Name
Name des Links
Auch dabei ist der Einsatz von verlagsinternen Schluumlsseln moumlglich In diesem Fall wird der korrekt formatierte verlagsinterne Schluumlssel anstelle vom oumlffentlichen Identifikationscode verwendet Auf ein separates Einbaubeispiel wird in diesem Dokument verzichtet
233 Base64url enkodierte Zaumlhlmarken
Die verwendbaren Zeichen in einer Zaumlhlmarke sind stark beschraumlnkt (siehe oben) Sollten verlagsinterne Schluumlssel mit nicht erlaubten Zeichen zum Einsatz kommen kann die Zaumlhlmarke Base64url (Codepage UTF-8) enkodiert werden In diesem Fall wird die encodierte Zaumlhlmarke mit Praumlf ix bdquobase64-ldquo eingebaut
Zum Thema Base64url Die Zeichen + und werden nach der Base64-Enkodierung durch - (Minus ASCII 2Dhex) und _ (Unterstrich ASCII 5Fhex) ersetzt
Einbaubeispiel verlagsinterner Schluumlssel in HTML (irgendwo zwischen ltbodygt und ltbodygt)
Verlagsinterner Schluumlssel vgzm415900-101007s00101-015-0101-z
Base64url encoded dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg==
ltIMG src=httpdomainmetvgwortdenabase64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
234 Zaumlhlung von Texten hinter Bezahlschranken
Zugriffe von Texten hinter Bezahlschranken werden mit Faktor 3 multipliziert Die Aufwertung der Zaumlhlwerte hinter Bezahlschranken erfolgt mittels einer gesonderten Zaumlhlung Hierfuumlr muss der Verlag die Zaumlhlmarke beim Einbau mit einem Praumlfix versehen Dieses Praumlfix darf nur fuumlr Texte hinter Bezahlschranken verwendet werden Ist der Text frei zugaumlnglich wird die Zaumlhlmarke wie bisher (ohne Praumlf ix) eingebaut Aufgrund des Praumlfixes kann unterschieden werden ob ein Text hinter einer Bezahlschranke ist oder nicht
Um Texte hinter Bezahlschranken melden zu koumlnnen muumlssen Sie fuumlr die VG WORT zuerst einen kostenfreien Zugang auf diese Texte einrichten Dies ist uumlber die Angabe von Zugangsdaten oder uumlber die Freischaltung von IP Adressen moumlglich (im TOM Menuuml unter Zugriff auf zugangsbeschraumlnkte Inhalte erlauben)
Das Praumlf ix lautet bdquopw-ldquo bdquopwldquo steht fuumlr den englischen Begriff bdquoPaywallldquo (Bezahlschranke)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 13 von 39
Bearbeitungsstand final
Einbaubeispiele
VG WORT Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-
c5b7568d28884052a9ff92d5afd08f34 height=1 width=1 border=ldquo0ldquogt
Base64URL encodierte Zaumlhlmarke hinter Bezahlschranke in HTML
ltIMG src=httpdomainmetvgwortdenapw-base64-
dmd6bS40MTU5MDAtMTAuMTAwNy9zMDAxMDEtMDE1LTAxMDEteg== height=1 width=1 border=ldquo0ldquogt
VG WORT Zaumlhlmarke als JavaScript Aufruf
lthtmlgtltheadgt
ltscriptgt
function vgwPixelCall()
documentgetElementById(div_vgwpixel)innerHTML=ltimg
src=httpdomainmetvgwortdenapw-
98380ae3fc0a4daf84d6197274add99e width=1 height=1 alt=gt
ltscriptgtltheadgt
ltbodygt
lta href=ldquohttpwwwstepscondebeispielpdfrdquo target=_target
onclick=vgwPixelCall()gtLINK-Nameltagt
ltdiv id=div_vgwpixelgtltdivgt
ltbodygtlthtmlgt
235 Zaumlhlung von Texten auf verschluumlsselten Seiten (https)
Beim Einbau von Zaumlhlmarken in https ndash Seiten ist zu beachten dass auch die Zaumlhlmarke als https Link eingebaut wird
Dh httpsdomainmetvgwortde statt httpdomainmetvgwortde
In der Vergangenheit musste bei Zaumlhlungen von https- Seiten eine separate Zaumlhldomaumlne verwendet werden Wenn Sie die Zaumlhlungen uumlber diese separate Domaumlne eingebaut haben muumlssen Sie den Einbau nicht aumlndern Diese Variante wird weiterhin unterstuumltzt
236 Potenzielle Fehlerquelle Referrer-Tag
Bestimmte Einstellungen im Quellcode koumlnnen dazu fuumlhren dass Zaumlhlungen nicht mehr zugeordnet werden koumlnnen wenn die Meldungen eingehen Es sieht dann so aus als waumlren d ie Zaumlhlungen zu einem Text falsch (zB nur uumlber eine Startseite ohne den eigentlichen Text) erfolgt Das kann dazu fuumlhren dass diese Zaumlhlungen gestrichen werden und der Mindestzugriff nicht mehr gegeben is t Um solche Probleme zu vermeiden muumlssen Sie darauf achten wie das Referrer-Metatag im Quellcode Ihrer Seite eingestellt ist
Die Zeile ltmeta name=referrer content=origingt sorgt zB dafuumlr dass eine Seite die httpswwwbeispieldemein_texthtml heiszligt nur httpswwwbeispielde sendet Damit lassen s ich dann die Zugriffe nicht mehr der richtigen Seite zuordnen
Bei weiteren Einstellungen wird das Senden der Daten vollstaumlndig unterdruumlckt Auch dies kann dazu fuumlhren dass Zaumlhlungen nicht anerkannt werden wenn weitere Faktoren darauf hindeuten dass die Zaumlhlungen nicht korrekt sein koumlnnten
Nur bei den Einstellungen ltmeta name=referrer content=no-referrer-when-downgradeldquogt oder ltmeta name=referrer content=unsafe-urlgt kann man auf gezaumlhlten Seiten 100 sicher sein dass keine Meldungen wegen nicht nachvollziehbarer Zugriffszaumlhlungen abgewiesen werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 14 von 39
Bearbeitungsstand final
237 Potenzielle Fehlerquelle bdquoLazy Loadldquo
Diese Funktion ist in bestimmten Faumlllen hoch problematisch und in anderen Faumlllen sogar zwingend erforderlich
Die Verwendung von bdquoLazy Loadldquo ist immer zu vermeiden wenn sich auf einer URL nur ein Text oder nur ein Teil eines mehrseitigen Textes befindet Hier fuumlhrt die Funktion dazu dass die Zaumlhlmarken erst geladen werden wenn die Stelle mit der Zaumlhlmarke im Browser angezeigt wird Insbesondere wenn die Zaumlhlmarke am Ende der Seite oder des Textes eingebaut wird sorgt die Funkt ion dafuumlr dass unser Zaumlhlbild nur geladen wird wenn der Leser auch an der Stelle ankommt also zB bis ganz ans Ende der Seite oder des Textes scrollt Erreicht er die Stelle nicht weil die Zaumlhlmarke zB erst unterhalb der Seite und nach Werbeeinblendungen oder Kommentaren eingebaut ist dann wird das Bild auch nicht vom Zaumlhlserver abgerufen und es erfolgt somit auch KEINE Zaumlhlung
Anders sieht es hingegen aus wenn sich viele Texte auf einer Seite befinden oder weitere Texte automatisch eingeblendet werden sobald ein Leser das Textende des ersten Textes erreicht hat Da nicht automatisch davon ausgegangen werden kann dass Texte die vom jeweil igen Nutzer nicht gesucht wurden eine Kopierwahrscheinlichkeit haben darf in diesen Faumlllen die Zaumlhlung nur erfolgen wenn der Text tatsaumlchlich ausgewaumlhlt wird Dies kann mit Hilfe von Lazy load erreicht werden Dazu baut man die jeweilige Zaumlhlmarke am besten immer ab der Mitte eines Textes ein so dass einerseits sichergestellt ist dass gezaumlhlt wird und andererseits dass nur eine Zaumlhlung erfolgt wenn wirklich ein bestimmter Text angesehen wurde und damit die notwendige Kopierwahrscheinlichkeit gegeben ist
24 Uumlberpruumlfen der Zaumlhlungen
241 Anzeige Herunterladen in der Anwendung
In der Anwendung gibt es eine Funktionalitaumlt mit der man pruumlfen kann welche Zaumlhlmarken bereits gezaumlhlt werden bzw welche Zaumlhlmarken die Mindestzugriffe uumlberschritten haben Dadurch kann man feststellen ob der Einbau dieser Zaumlhlmarken korrekt ist Diese Funktionalitaumlt kann uumlber den Menuumlpunkt bdquoZaumlhlmarkenuumlbersichtldquo abgerufen werden Siehe Abbildung unten
Abbildung 3 Maskenbeschreibung Zaumlhlerstarts
Dabei gibt es folgende Filtermoumlglichkeiten
- bdquoIdentif ikationscodeldquo Der oumlffentliche bzw private Identifikationscode oder der verlagsinterne Schluumlssel der Zaumlhlmarke
- bdquoBestelldatum (von bis)ldquo Bestelldatum der Zaumlhlmarke
- bdquoMeldung erfolgtldquo Es werden nur Zaumlhlmarken angezeigt fuumlr die bereits eine Meldung vorliegt
- bdquoZaumlhlerstart erfolgtldquo Alle Zaumlhlmarken die gezaumlhlt werden
- bdquoMindestzugriffldquo Alle Zaumlhlmarken die den Mindestzugriff oder den anteiligen Mindestzugriff uumlberschritten haben
- bdquoin Ausgeblendete Zaumlhlmarken suchenldquo Es werden auch Zaumlhlmarken gesucht die uumlber die angebotene Funktionalitaumlt ausgeblendet wurden Zaumlhlmarken sollten ausgeblendet werden wenn diese in Texten eingebaut wurden die den Kriterien der VG WORT nicht entsprechen (zB zu kurze Texte) Ansonsten scheinen diese Zaumlhlmarken weiterhin staumlndig in der Suchergebnisliste auf
Die Filtermoumlglichkeiten fuumlr den Mindestzugriff greifen sobald die ersten Zaumlhldaten fuumlr ein Kalenderjahr vorliegen Allerdings ist die Anzeige fuumlr das laufende Jahr unter Vorbehalt und erfolgt auf der Basis
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 15 von 39
Bearbeitungsstand final
des letzten bekannten Mindestzugriffes Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
Die Zaumlhlmarken koumlnnen zusaumltzlich als Liste im CSV Format heruntergeladen werden
Der Zaumlhlerstart wird mit einer Verzoumlgerung von ca 4 Tagen angezeigt Dh wenn eine Zaumlhlmarke heute eingebaut wird scheint diese in der Statistik erst in ca 4 Tagen auf
Es empfiehlt sich testweise einige wenige Zaumlhlmarken einzubauen und zu pruumlfen ob die Zaumlhlungen korrekt gestartet werden bevor man den Einbau der Zaumlhlmarken auf das gesamte Internetangebot ausrollt
242 Abruf uumlber Web Service Schnittstelle
Im Gegensatz zur Maske (siehe oben) kann man uumlber das Web Service nur die Zaumlhlmarken bdquomit Mindestzugriff ohne Meldungldquo sowie bdquomit anteiligem Mindestzugriff ohne Meldungldquo herunterladen
Web Service Request URL httpstomvgwortdeservices10PixelService XSD Definition httpstomvgwortdeservices10pixelServicexsd WSDL Definition httpstomvgwortdeservices10pixelServicewsdl
2421 pixelOverviewRequest
Feld Typ Beschreibung
offset Int Wiederaufsetzpunkt Das System returniert maximal 100 Zaumlhlmarken am Stuumlck
Falls es mehr Zaumlhlmarken gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
Beispiel (190 Zaumlhlmarken vorhanden)
1 Abfrage (offset = 0) Die Zaumlhlmarken 1 ndash 100 werden zuruumlckgegeben
2 Abfrage (offset = 100) Die Zaumlhlmarken 101 ndash 190 werden zuruumlckgegeben
type Auswahl Entweder bdquoMINDESTZUGRIFFldquo oder bdquoANTEILIGER_MINDESTZUGRIFFldquo
2422 pixelOverviewResponse
Feld Typ Beschreibung
Amount Int Anzahl der gefundenen Zaumlhlmarken
Offset Int Der beim Request angegebene offset
privateIdentificationId pixelIDType (Liste) Privater Identifikationscode oder verlagsinterner Schluumlssel
der Zaumlhlmarke
2423 pixelOverviewFault
Feld Typ Beschreibung
Errorcode Int Der Fehlercode
Errormsg string Grund fuumlr den Bestellabbruch
24231 Fehlercodes
Fehlerfall Fehlercode maxOrder Meldung
TechnischerFehler 100 0 Technischer Fehler
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 16 von 39
Bearbeitungsstand final
3 Meldung Nachdem eine Zaumlhlmarke bestellt und eingebaut wurde kann eine Meldung zum jeweiligen Text erfolgen Eine Meldung soll dann gemacht werden wenn sich der Text des gemeldeten Artikels nicht mehr wesentlich aumlndert da die VG WORT in den Pruumlfmechanismen den gemeldeten Text mit dem Text der sich tatsaumlchlich im Internet befindet vergleicht
Der spaumlteste Zeitpunkt zum Melden eines Textes ist der sogenannte Meldeschlusstermin Diesen f inden Sie auf der Homepage der VG WORT unter bdquoTermineldquo Derzeit ist der Meldeschluss fuumlr Verlage der 1 Juni des auf die Zaumlhlung folgenden Jahres
In den meisten Faumlllen empfiehlt sich eine bdquoWartefristldquo von 14 Tagen bevor die Meldung erstellt wird So lange der Text noch Aumlnderungen unterzogen wird besteht die Gefahr dass die von der VG WORT durchgefuumlhrten Pruumlfmechanismen fehlschlagen
Bitte setzen Sie sich vor Meldungen zu Texten die uumlber verlagsinterne Schluumlssel gezaumlhlt werden unbedingt mit der VG WORT (per Email an metissupportvgwortde) in Verbindung
31 Anforderungen an die Meldung
Anbei f inden Sie alle Daten die bei einer Meldung angegeben werden muumlssen - Eindeutiger Identifikationscode - Alle beteiligten Autoren Uumlbersetzer und Agenturen - Kurzbeschreibung Uumlberschrift (Titel) - Text - Erscheinungsorte (Webbereiche)
311 Eindeutiger Identifikationscode
Der Identif ikationscode zur Zaumlhlmarke die in den Text eingebaut wurde Je nachdem welche Zaumlhlmarke verwendet wird ist dies der private Identifikationscode (bei VG WORT Zaumlhlmarken) oder der verlagsinterne Schluumlssel
312 Alle beteiligten Autoren Uumlbersetzer und Agenturen
Alle die am Text beteiligt sind Es gibt drei Arten wie die Autoren undoder Uumlbersetzer gemeldet werden
Vorname + Nachname + Karteinummer Die bevorzugte Variante Dabei werden von einem Autor oder einem Uumlbersetzer der Vorname der Nachname und die VG WORT Karteinummer gemeldet Eine Meldung mit Schreibweisen oder Pseudonymen ist auch moumlglich wenn diese der VG WORT bekannt sind Der Vorteil an dieser Variante ist dass ein Autor somit bei der VG WORT eindeutig identifizierbar ist und der Verlag somit keine weiteren Schritte unternehmen muss damit der jeweilige Autor zu seiner Ausschuumlttung kommt
Diese Variante beinhaltet fuumlr den Verlag zwar einen Initialaufwand da die Karteinummern aller Autoren eingesammelt werden muumlssen in der Praxis hat sich diese Variante bei den meisten teilnehmenden Verlagen aber als die einfachste Variante erwiesen
Vorname + Nachname Wenn von einem Autor die VG WORT Karteinummer nicht bekannt ist kann der Autor auch uumlber den Vornamen und den Nachnamen gemeldet werden Den Autoren steht fuumlr das Auffinden der ausschuumlttungsrelevanten Meldungen eine Suchmaske zur Verfuumlgung Allerdings muss in diesem Fall der gemeldete Name exakt mit dem uumlbereinstimmen der im Datenbestand der VG WORT vorliegt
Ist der Vorname nicht vollstaumlndig bekannt kann er in der Variante erster Buchstabe des Vornamens + Punkt angegeben werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 17 von 39
Bearbeitungsstand final
Urheber ohne Wahrnehmungsvertrag Hat der Urheber des zu meldenden Werkes dem meldenden Verlag fuumlr dieses Werk die von der VG WORT wahrgenommenen gesetzlichen Verguumltungsanspruumlche nach dem Urheberrechtsgesetz abgetreten kann dieser Urheber mit Namen Geburtsdatum und Adresse angegeben werden Zusaumltzlich muss bestaumltigt werden dass der Urheber die Rechte uumlbertragen hat Die uumlbertragenen Rechte werden bei der Ausschuumlttung beruumlcksichtigt
Fuumlr Agenturmeldungen bei denen die Autoren nicht bekannt sind steht eine weitere Variante zur Verfuumlgung
Die Rechte koumlnnen dem Verlag erst nach der Veroumlffentlichung des Textes uumlbertragen werden Die schriftliche Rechteuumlbertragung des jeweiligen Autors muss der VG WORT jederzeit auf Anfrage zur Verfuumlgung gestellt werden
Kuumlrzel Wenn man eine Agentur melden moumlchte dann kann das aktuell uumlber diesen Weg erfolgen Als Kuumlrzel wird die Kurzbezeichnung der jeweiligen Agentur uumlbergeben (zB bdquodpaldquo)
Namentliche bekannte Urheber koumlnnen uumlber die Angabe bdquoKuumlrzelldquo nicht gemeldet werden Diese Angabe kann ausschlieszliglich fuumlr die Meldung von Agenturtexten bzw der Miturheberschaft eines nicht namentlich bekannten Agenturautoren verwendet werden
313 Kurzbeschreibung Uumlberschrift (Titel)
Der Titel des zu meldenden Artikels
314 Text
Der Text des zu meldenden Artikels (entweder als Klartext als PDF oder im EPUB Format) Benoumltigt wird der bdquoNettotextldquo (dh der Text ohne HTML Code und ohne Menuuml oder dergleichen)
315 Erscheinungsorte (Webbereiche)
Es muumlssen alle Erscheinungsorte des Texts auf denen die Zaumlhlmarke eingebaut wurde gemeldet werden Ein Erscheinungsort definiert sich aus allen URLs die benoumltigt werden um den gesamten Text einmal zu lesen
Beispiel 1 Ein Text der sich uumlber 2 URLs erstreckt muss mit einem Webbereich (mit 2 URLs) gemel-det werden (zB httpdomain1depage1html httpdomain1depage2html)
Beispiel 2 Ein Text der sich uumlber 1 URL erstreckt aber auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils einer URL) gemeldet werden (zB httpdomain1demytexthtml und httpdomain2demytexthtml)
Beispiel 3 Ein Text der sich uumlber 2 URLs erstreckt und auf zwei unterschiedlichen Seiten erscheint muss mit zwei Webbereichen (mit jeweils zwei URLs) gemeldet werden (zB httpdomain1depage1html httpdomain1depage2html und httpdomain2depage1html httpdomain2depage2html)
32 Meldung uumlbermitteln
321 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 18 von 39
Bearbeitungsstand final
3211 Empfehlungen zum Umgang mit dem Web Service
bull Es sollen nur Texte gemeldet werden die bereits bdquostabilldquo sind (dh die sich nicht mehr haumlufig aumlndern) Aus diesem Grund wird empfohlen die Texte mit einer Zeitverzoumlgerung von einigen Tagen (zB 14 Tagen) zu melden Auf die Tantieme hat das keinen Einfluss da die Ausschuumlttung erst Ende September Anfang Oktober fuumlr das Vorjahr erfolgt
bull Die Meldungen sollen taumlglich in der Nacht uumlbertragen werden Zeitfenster 2200 ndash 0300 Von 0300 bis 0600 gibt es ein allgemeines Wartungsfenster wo nicht gemeldet werden kann
bull Um eine Uumlberlastung der Server (und somit houmlhere Wartezeit) zu verhindern sollen die Meldungen sequentiell (nicht parallel) uumlbertragen werden Idealerweise soll zwischen zwei Meldungen eine Sekunde verstreichen Aus transaktionaler Sicht wird jede Meldung einzeln behandelt Dh jede erfolgreich eingehende Meldung wird gespeichert ndash unabhaumlngig davon ob die vorherige oder nachfolgende Meldung einen Fehler verursacht hat
bull Alle fachlichen Fehlercodes (ein- oder zweistellig) deuten auf einen Fehler in der Meldung hin Es ist zwecklos diese Meldung unveraumlndert noch einmal abzusenden Dreistellige Fehler (sowie der HTML ndash 500 Fehler) deuten auf technische Probleme hin Hier ist es zweckmaumlszligig dieselben Meldungen zu einem spaumlteren Zeitpunkt (zB mit den Meldungen vom naumlchsten Tag) noch einmal zu uumlbertragen
bull Die Bestaumltigung der Meldung bedeutet dass die Meldung aus technischer Sicht in Ordnung ist (dh Mindestumfang von 1800 Zeichen die Zaumlhlmarke existiert hellip) In einer spaumlteren Phase werden die Meldungen noch durch automatische Pruumlfmechanismen der VG WORT in Stichproben gepruumlft Sollten dabei Maumlngel auftreten werden die betreffenden Meldungen zuruumlckgewiesen und der Inhaber des Meldekontos bei der VG WORT wird per Email verstaumlndigt Diese Meldungen koumlnnen dann im Portal entweder geloumlscht oder manuell nachbearbeitet und erneut versendet werden
3212 newMessageRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der private
Identifikationscode (bei VG WORT Zaumlhlmarken) oder der
verlagsinterne Schluumlssel
Parties Parties Die Urheber Uumlbersetzer Agenturen der Meldung Es muss mindestens ein Autor oder ein Uumlbersetzer angegeben werden
Es koumlnnen in einer Meldung sowohl Autoren als auch
Uumlbersetzer angegeben werden
partiesauthors Authors 0 bis mehrere Autoren Beschreibung siehe separate Tabelle
partiestranslators Translators 0 bis mehrere Uumlbersetzer Beschreibung siehe separate
Tabelle
messagetext MessageText Der gemeldete Text entweder als PDF EPUB oder als Klartext
messagetextshorttext string Kurzbezeichnung Uumlberschrift vom Text
messagetexttext Text Der Text an sich Beschreibung siehe separate Tabelle
messagetextlyric boolean bdquoTrueldquo wenn es sich beim Text um Lyrik handelt ansonsten
bdquoFalseldquo
webranges Webranges Erscheinungsort(e) unter demdenen der Text gefunden werden
kann
webrangeswebrange Webrange Ein Erscheinungsort Beschreibung siehe separate Tabelle
Authors Feld Typ Beschreibung
Author Involved Einer oder mehrere Autoren Die
Angabe erfolgt uumlber bdquofirstNameldquo +
bdquosurNameldquo + bdquocardNumberldquo oder
bdquofirstNameldquo + bdquosurNameldquo oder
bdquocodeldquo
authorcode codeType Das Kuumlrzel der Agentur 2-4
Zeichen
authorfirstName string Vorname (2-40 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 19 von 39
Bearbeitungsstand final
authorsurName string Nachname (2-255 Zeichen)
authorcardNumber cardNumberType Guumlltige VG WORT Karteinummer
AuthorWithoutContract InvolvedWithoutContract Einer oder mehrere Autoren deren Rechte an den Verlag uumlbertragen
wurden
authorWithoutContractfirstName string Vorname (2-40 Zeichen)
authorWithoutContractsurName string Nachname (2-255 Zeichen)
authorWithoutContractbirthday dateString Geburtsdatum (TTMMJJJJ)
authorWithoutContractstreet string Straszlige (1-249 Zeichen)
authorWithoutContracthouseNumber string Hausnummer (1-5 Zeichen)
authorWithoutContractpostCode string Postleitzahl (1-9 Zeichen)
authorWithoutContractcity string Ort (1-60 Zeichen)
authorWithoutContractcountryCode countryType Laumlndercode (2 Zeichen - ISO-3166
ALPHA-2)
authorWithoutContracttransferOfRights boolean bdquoTrueldquo wenn die Rechte uumlbertragen
wurden ansonsten bdquoFalseldquo
Translators
Feld Typ Beschreibung
translator Involved Es werden dieselben Felder wie bei bdquoAuthorldquo benoumltigt
Beschreibung siehe oben
translatorWithoutContract InvolvedWithoutContract Es werden dieselben Felder wie bei
bdquoAuthorWithoutContractldquo benoumltigt Beschreibung siehe
oben
Text Feld Typ Beschreibung
pdf base64BinaryMax15MB Der Text in PDF Form (base 64 encoded) Maximale Groumlszlige
15 MB
epub base64BinaryMax15MB Der Text in EPUB Form (base 64 encoded) Maximale Groumlszlige
15 MB
plainText base64BinaryMax15MB Der Klartext ohne HTML und sonstigen
Formatierungsinformationen (base 64 encoded) Maximale
Groumlszlige 15 MB
Webrange Feld Typ Beschreibung
url urlType Eine bis mehrere guumlltige URLs Maximale Groumlszlige 180 Zeichen
3213 newMessageResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird newMessageFault gesendet
3214 newMessageFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr die Verweigerung der Meldungsannahme
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 20 von 39
Bearbeitungsstand final
32141 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden
1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Es existiert keine Meldung und
die Zaumlhlmarke gehoumlrt einem
anderen Benutzer
2 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Erstmeldung dazu ist nur durch
diesen Benutzer moumlglich
Die Erstmeldung zu dieser
Zaumlhlmarke ist bereits erfolgt
3 Privater Identifikationscode Die Erstmeldung zu dieser
Zaumlhlmarke wurde bereits durchgefuumlhrt
Karteinummer und Nachname
stimmt nicht uumlberein
4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Der Text im Textfeld oder im Dokument hat weniger als 1800
Zeichen und nicht bdquoLyrikldquo
5 Der gemeldete Text hat nicht die erforderliche Mindestlaumlnge
von 1800 Zeichen (inkl Leerzeichen)
Uumlbermittelter Text ist falsch
encodiert 7 Der gemeldete Text ist nicht korrekt kodiert Bitte verwenden
Sie UTF-8
Im Feld pdf befindet sich keine
guumlltige pdf ndash Datei 8 Die uumlbermittelte Datei ist kein PDF
Beteiligter doppelt gemeldet 9 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName kann nicht doppelt gemeldet
werden
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Zu viele Sonderzeichen 11 Meldetext Der Meldetext enthaumllt zu viele Sonderzeichen
Zu viele Wiederholungen 12 Meldetext Der Meldetext besteht aus zu vielen
wiederholenden WoumlrternSaumltzen
Mehr als 100 Webbereiche 13 Die Gesamtzahl der Webbereiche darf 100 nicht
uumlberschreiten
Mehr als 1000 Urls 14 Die Gesamtanzahl der Urls darf 1000 nicht uumlberschreiten
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Kuumlrzel und Name gemeldet 18 Die Meldung des Beteiligten Vorname Nachname ist in dieser Form nicht mehr moumlglich da die Meldung mit Vorname
Nachname und Kuumlrzel nicht mehr akzeptiert wird Bitte melden
Sie die Beteiligten nur mit Vorname und Nachname
Keine Zugangsdaten obwohl
Text hinter Bezahlschranke 19 Der gemeldete Text wurde als kostenpflichtig gezaumlhlt Um
kostenpflichtige Texte melden zu koumlnnen muumlssen Sie fuumlr die
VG WORT zuerst einen kostenfreien Zugang auf diese Texte
einrichten Dies ist uumlber die Angabe von Zugangsdaten oder
uumlber die Freischaltung von IP Adressen moumlglich
(Eingabemoumlglichkeit bzw die freizuschaltenden IP Adressen
finden Sie unter Zugriff auf zugangsbeschraumlnkte Inhalte
erlauben)
Im Feld epub befindet sich keine
guumlltige EPUB Datei
20 Die uumlbermittelte Datei ist kein ePub
EPUB mit DRM 21 Die uumlbermittelte Datei ist DRM-geschuumltzt Eine Meldung zu
DRM-geschuumltzten Texten ist nicht moumlglich
EPUB nicht extrahierbar 22 Der Text konnte nicht aus der ePub-Datei extrahiert werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 21 von 39
Bearbeitungsstand final
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
der VG WORT
25 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Wahrnehmungsvertrag mit der
VG WORT Bitte aumlndern Sie die Art der Beteiligung
Der angegebene Urheber ohne Wahrnehmungsvertrag hat
einen Wahrnehmungsvertrag mit
einer Schwesterngesellschaft
der VG WORT
26 Der Beteiligte Vorname Nachname mit GebDat Geburtsdatum besitzt einen Wahrnehmungsvertrag mit einer
Schwesterngesellschaft der VG WORT Bitte aumlndern Sie die
Art der Beteiligung
Der angegebene Urheber ohne
Wahrnehmungsvertrag hat
einen Vertrag mit der VG WORT
27 Der Beteiligte Vorname Nachname mit GebDat
Geburtsdatum besitzt einen Vertrag mit der VG WORT Bitte
aumlndern Sie die Art der Beteiligung
Im Feld bdquotransferOfRightsldquo steht
n icht bdquotrueldquo 28 Sie muumlssen bestaumltigen dass der Autor bzw Uumlbersetzer
Vorname Nachname mit GebDat Geburtsdatum die
Rechte des Werkes an Ihren Verlag uumlbertragen hat
Im Feld bdquocountryCodeldquo steht kein
Laumlndercode nach ISO-3166
ALPHA-2
29 Das zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene Land konnte nicht gefunden
werden
Das Feld bdquocountryCodeldquo
beinhaltet den Wert bdquoDEldquo es
wurde jedoch keine 5-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben bzw das Feld
bdquocountryCodeldquo beinhaltet den
Wert bdquoATldquo oder bdquoCHldquo es wurde
jedoch keine 4-stellige
Postleitzahl im Feld bdquopostCodeldquo
angegeben
30 Die zum Beteiligten Vorname Nachname mit GebDat
Geburtsdatum angegebene PLZ ist nicht im richtigen Format
(fuumlr Land muss eine Laumlnge der Postleitzahl-stellige PLZ
angegeben werden)
Ein angegebener Urheber wird
mehrfach unter den
Beteiligungen angegeben
31 Beteiligte Der angegebene Name Vorname Nachname
kann nicht doppelt gemeldet werden
Kein Beteiligter ist der Autor 32 Beteiligte Es muss mindestens ein Autor am Werk beteiligt
sein
Der gemeldete Text wurde
doppelt Base64 encodiert
39 Der gemeldete Text wurde doppelt mit Base64 encodiert
Technischer Fehler 100 Technischer Fehler
Der im Kapitel Fehler Verweisquelle konnte nicht gefunden werden vorgestellte Web Service Client erspart gerade bei der Meldungsschnittstelle einige Tage Entwicklungsaufwand und bietet zudem eine fehlerlose und getestete Anbindung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 22 von 39
Bearbeitungsstand final
322 Meldung uumlber Eingabemaske
Abbildung 4 Maskenbeschreibung Meldung
33 Meldungsrecherche
Alle Meldungen die ein Verlag erstellt hat kann dieser 3 Jahre lang uumlber die Meldungsrecherche f inden und uumlberpruumlfen
331 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3311 researchMetisMessagesRequest
Feld Typ Beschreibung
Offset int Wiederaufsetzpunkt Das System returniert maximal 100 Meldungen am Stuumlck
Falls es mehr Meldungen gibt die die Kriterien erfuumlllen koumlnnen weitere
Zaumlhlmarken uumlber den offset ausgelesen werden
dateTo date Suche aller Meldungen die bis zu diesem Datum erstellt wurden (optional)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 23 von 39
Bearbeitungsstand final
Title string Suche aller Meldungen mit dem angegebenen Titel (optional)
firstName string Suche aller Meldungen die einen Urheber mit diesem Vornamen aufweisen
(optional)
surName string Suche aller Meldungen die einen Urheber mit diesem Nachnamen aufweisen
(optional)
cardNumber cardNumber
Type
Suche alles Meldungen die einen Urheber mit dieser Karteinummer aufweisen
(optional)
Alle Suchkriterien koumlnnen beliebig miteinander kombiniert werden
3312 researchMetisMessageResponse
Feld Typ Beschreibung
amount Int Anzahl der gefundenen Meldungen
Offset Int Der beim Request angegebene offset
researchedMetisMessage messageType
(Liste)
Liste der Meldungen Auf eine genaue Beschreibung vom
Typ wird verzichtet Ein Beispiel response findet sich am
Ende des Dokuments
3313 researchMetisMessageFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
332 Uumlber Maske
Die Meldungsrecherche steht auch uumlber eine Maske (Menuumlpunkt bdquoRecherche in eigenen Meldungenldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Abbildung 5 Maskenbeschreibung Recherche in eigenen Meldungen
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 24 von 39
Bearbeitungsstand final
34 Urhebermeldung
Nachdem der Verlag die Meldungen ordnungsgemaumlszlig durchgefuumlhrt hat muumlssen die beteiligten Autoren und Uumlbersetzer noch mit der Meldung in Verbindung gebracht werden um an der Ausschuumlttung teilnehmen zu koumlnnen Die Autoren koumlnnen erst melden sobald der Mindestzugriff fuumlr das jeweilige Kalenderjahr feststeht (im Mai des Folgejahres) und wenn der jeweilige Text den Mindestzugriff erreicht hat
Um an der Ausschuumlttung teilnehmen zu koumlnnen muumlssen Urheber neben einer VG WORT-Karteinummer auch uumlber eine Meldesystemregistrierung bei der VG WORT verfuumlgen (Registrierung unter httptomvgwortde)
Falls der Verlag bei der Meldung der Autoren und Uumlbersetzer bereits die Karteinummer uumlbermittelt hat erfolgt die Verstaumlndigung des jeweiligen Autors Uumlbersetzers durch die VG WORT Da die Person durch die VG WORT eindeutig zugewiesen werden kann ist es fuumlr den jeweiligen Autor Uumlbersetzer nur noch noumltig seine Meldungen in einer Liste zu bestaumltigen um seine Anteile zu sichern
Kann der Verlag Urheber nur mit deren Namen (Vornamen + Nachnamen) anmelden so koumlnnen die Urheber solche Meldungen unter dem Menuumlpunkt bdquoHinzufuumlgen zu einer Verlagsmeldungldquo recherchieren sobald die Meldung vom Verlag eingereicht der Mindestzugriff fuumlr ein Kalenderjahr festgelegt und sofern der jeweilige Mindestzugriff vom Text erreicht wurde Allerdings funktioniert diese Suche fuumlr Urheber nur wenn in der Verlagsmeldung der bdquoKlarnameldquo des Urhebers in identischer Schreibweise zu den der VG WORT bekannten Daten angegeben wurde Ist dies nicht moumlglich weil zB ein Pseudonym (ohne Karteinummer) in der Meldung angegeben wurde hat der Urheber Anspruch auf Zusendung des Identifikationscodes zur betreffenden Meldung um damit seinen Anspruch geltend zu machen
Sollte ein Verlag den Urhebern es generell nicht ermoumlglichen an der Ausschuumlttung teilzunehmen wird er von der Ausschuumlttung ausgeschlossen
35 Pruumlfung der Karteinummer
Bei der Uumlbermittlung einer Verlagsmeldung wird gepruumlft ob die Kombination bdquoKarteinummer Nachname bzw SchreibweisePseudonymldquo fuumlr einen Urheber guumlltig ist Das bdquoEinsammelnldquo von Karteinummern hat sich in der Vergangenheit fuumlr Verlage als schwierig erwiesen da man immer wieder mit Zifferndrehern konfrontiert war die erst zum Zeitpunkt der Meldung festgestellt werden konnten Um die Verlage bereits beim Einpflegen der Karteinummern in den internen Urheberbestand zu unterstuumltzen gibt es ein Web Service mit dem man pruumlfen kann ob die Kombination bdquoKarteinummer buumlrgerlicher Nachnameldquo bzw die Kombination bdquoKarteinummer PseudonymSchreiweiseldquo guumlltig ist Zur Pruumlfung mit Pseudonymen bzw Schreibweisen ist die Angabe des Vornamens zwingend erforderlich
351 Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3511 checkAuthorRequest
Feld Typ Beschreibung
cardNumber cardNumberType Karteinummer des Urhebers
surName String Nachname des Urhebers
firstName String Vorname des Urhebers (optional) Wird zur Pruumlfung von
Pseudonymen bzw Schreibweisen benoumltigt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 25 von 39
Bearbeitungsstand final
3512 checkAuthorResponse
Feld Typ Beschreibung
Valid boolean Wenn die Kombination Karteinummer und Nachname guumlltig ist
wird bdquotrueldquo zuruumlckgegeben ansonsten bdquofalseldquo
3513 checkAuthorFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
Errormsg string Grund fuumlr den technischen Fehler
36 Ergaumlnzung gemeldeter Beteiligter
Alle Beteiligten die ein Verlag gemeldet hat kann dieser uumlber die Ergaumlnzung gemeldet Beteiligter f inden und die Karteinummer ergaumlnzen oder die Daten fuumlr Urheber ohne Wahrnehmungsvertrag einpf legen
Es koumlnnen nur Beteiligte ergaumlnzt werden die nicht mit Karteinummer und nicht als Urheber ohne Wahrnehmungsvertrag gemeldet wurden
Es koumlnnen nur Beteiligte mit gleichem Namen gleichzeitig bearbeitet werden
361 Meldung uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3611 updateMessageParticipantRequest
Feld Typ Beschreibung
privateidentificationid pixelIDType Identifikationscode der Zaumlhlmarke Entweder der
private Identifikationscode (bei VG WORT
Zaumlhlmarken) oder der verlagsinterne Schluumlssel
participants participants Die Beteiligten zu einer Meldung
participantsparticipant participantWithCardNumber 1 bis mehrere Beteiligte Beschreibung siehe
separate Tabelle
Participant
Feld Typ Beschreibung
firstname string_2-40 Vorname (2-40 Zeichen)
surName String_2-255 Nachname (2-255 Zeichen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 26 von 39
Bearbeitungsstand final
3612 updateMessageParticipantResponse
Feld Typ Beschreibung
Status okType Status OK Wird im Erfolgsfall immer zuruumlckgeliefert Im Fehlerfall
wird updateMessageParticipantFault gesendet
3613 updateMessageParticipantFault
Feld Typ Beschreibung
Errorcode int Der Fehlercode
Errormsg string Grund fuumlr den Fehler
36131 Fehlercodes
Fehlerfall Fehler-code
Meldung
Es konnte keine Zaumlhlmarke
gefunden werden 1 Privater Identifikationscode Fuumlr den eingegebenen Wert
existiert keine Zaumlhlmarke
Karteinummer und Nachname
stimmt nicht uumlberein 4 Beteiligte Der zur Karteinummer cardNumber angegebene
Name surName firstName] stimmt nicht mit dem Namen
des Urhebers uumlberein
Die Zaumlhlmarke ist einem
anderen Benutzer zugeordnet 6 Privater Identifikationscode Die Zaumlhlmarke ist einem anderen
Benutzer zugeordnet Eine Webbereichsmeldung ist nur durch
diesen Benutzer moumlglich
Beteiligter darf kein Verlag sein 10 Beteiligte Der zur Karteinummer 0 angegebene Name 1 2
ist kein Autor Es koumlnnen nur Autoren gemeldet werden
Falsche Zaumlhlmarke 16 Privater Identifikationscode Die Zaumlhlmarke ist keine
Zaumlhlmarke fuumlr einen Text sondern fuumlr ein Groszligwerk
Fuumlr diese Meldung existiert
bereits eine Beteiligtenmeldung
zu dieser Karteinummer
47 Karteinummer Fuumlr diese Meldung existiert bereits eine
Beteiligtenmeldung zu dieser Karteinummer
Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
48 Privater Identifikationscode Die Zaumlhlmarke ist zu keiner
Meldung zugeordnet
Der angegebene Name existiert
nicht in der Beteiligtenmeldung
49 Beteiligte Der angegebene Name Nachname Vorname
existiert nicht in der Beteiligtenmeldung
Der angegebene Urheber ist
bereits an der Meldung beteiligt
51 Der Urheber Nachname(Vorname) ist bereits an der
Meldung mit privatem Identifikationscode Private ID des
Pixels beteiligt und kann nicht erneut hinzugefuumlgt werden
Die Meldung zu der
Privatidentifikationsnummer
kann nicht mehr bearbeitet
werden
52 Die Meldung kann nicht mehr bearbeitet werden da der
Benutzer sie bestaumltigt verworfen hat
Die Karteinummer gehoumlrt zu
keinem Verlag
53 Karteinummer Die eingegebene Karteinummer gehoumlrt einem
Urheber
Die angegebene Kombination
(Name + Karteinummer) weicht
von den vorhandenen Daten
54 Beteiligte Der angegebene Name und Karteinummer
Vorname Nachname angegebene Karteinummer weichen
von den existierenden Daten existierende Karteinummer ab
Technischer Fehler 100 Technischer Fehler
362 Uumlber Maske
Die Ergaumlnzung gemeldeter Beteiligter steht uumlber eine Maske (Menuumlpunkt bdquoErgaumlnzung gemeldeter Beteiligterldquo - bdquoMETIS-Meldungldquo) zur Verfuumlgung
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 27 von 39
Bearbeitungsstand final
Abbildung 6 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter
Durch die Auswahl mind eines Beteiligten und das Betaumltigen der Schaltflaumlche bdquoBeteiligte bearbei tenldquo gelangt man zur Maske fuumlr die Eingabe der Karteinummer
Abbildung 7 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber mit Karteinummer
Um die Daten von Urhebern ohne Wahrnehmungsvertrag einzugeben muss bdquoRechte uumlbertragenldquo ausgewaumlhlt werden
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 28 von 39
Bearbeitungsstand final
Abbildung 8 Maskenbeschreibung Ergaumlnzung gemeldeter Beteiligter ndash Urheber ohne Wahrnehmungsvertag
37 Qualitaumltskontrolle
Den Verlagen wird ermoumlglicht festzustellen ob die Umsetzung korrekt erfolgt ist Dafuumlr bietet die VG WORT eine Qualitaumltskontrolle an Dabei werden zwei allgemeine Daten zur Verfuumlgung gestellt
- Anzahl der bestellten Zaumlhlmarken (Tagesaktuell) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (Verzoumlgerung ca 4 Tage) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (Verzoumlgerung ca 4 Tage)
Daruumlber hinaus kann man pro Kalendermonat (fuumlr die letzten 12 Monate) folgende Daten abrufen - Anzahl bestellte Zaumlhlmarken (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - gesamt (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - frei zugaumlnglich (bis inkl dem jeweiligen Monat) - Anzahl der gezaumlhlten Zaumlhlmarken - hinter Bezahlschranke (bis inkl dem jeweiligen Monat) - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - gesamt - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die in dem jeweiligen Jahr voraussichtlich den Mindestzugriff
erreichen - hinter Bezahlschranke - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - gesamt - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - f rei zugaumlnglich - Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen aber fuumlr die es noch
keine Meldung gibt - hinter Bezahlschranke
Die Daten fuumlr ein Monat werden erst gegen Mitte des Folgemonats berechnet und zur Verfuumlgung gestellt
Grundlage fuumlr die Berechnung der Zaumlhlmarken die den Mindestzugriff erreichen erfolgt im laufenden Jahr unter Vorbehalt da die Berechnung nur auf der Basis des letzten bekannten Wertes moumlglich ist Die Zuordnung ohne Vorbehalt kann erst erfolgen sobald
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 29 von 39
Bearbeitungsstand final
der Mindestzugriff zu einem Jahr im Meldesystem eingegeben wurde (immer im Januar des Folgejahres)
371 Uumlber Web Service Schnittstelle
Web Service Request URL httpstomvgwortdeservices113MessageService XSD Definition httpstomvgwortdeservices113messageServicexsd WSDL Definition httpstomvgwortdeservices113messageServicewsdl
3711 qualityControlRequest
Um das Ergebnis der Qualitaumltskontrolle zu erhalten wird ein leerer bdquoqualityControlRequestldquo uumlbermittelt
3712 qualityControlResponse
Jedes bdquoqualityControlValuesldquo-Element beinhaltet den Monat und das Jahr fuumlr die uumlbermittelten Werte
Feld Typ Beschreibung
orderedPixelTillToday int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum aktuellen
Tag
startedPixelTillToday int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash gesamt
startedPixelTillTodayFree int_0-MAX Anzahl der gestarteten Zaumlhlungen - frei zugaumlnglich
startedPixelTillTodayPaid int_0-MAX Anzahl der gestarteten Zaumlhlungen ndash hinter
Bezahlschranke
qualityControlValues (qCV) QualityControlValues Werte der Qualitaumltskontrolle fuumlr den jeweiligen Monat
(maximal 12 Monate zuruumlck)
qCVmonth int_1-12 Monat fuumlr den die Werte gelten (1 ndash 12)
qCVyear int_1000-9999 Jahr fuumlr das die Werte gelten
qCVorderedPixel int_0-MAX Anzahl der bestellten Zaumlhlmarken bis zum jeweiligen
Monat
qCVstartedPixel int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash gesamt
qCVstartedPixelFree int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat ndash frei zugaumlnglich
qCVstartedPixelPaid int_0-MAX Anzahl der gezaumlhlten Zaumlhlmarken bis zum jeweiligen
Monat- hinter Bezahlschranke ndash hinter
Bezahlschranke
qCVminAccess int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash gesamt
qCVminAccessFree int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash frei zugaumlnglich
qCVminAccessPaid int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen (auf das jeweilige Jahr
bezogen) ndash hinter Bezahlschranke
qCVminAccessNoMessage int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) -
gesamt
qCVminAccessNoMessage
Free int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
frei zugaumlnglich
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 30 von 39
Bearbeitungsstand final
qCVminAccessNoMessage
Paid
int_0-MAX Anzahl der Zaumlhlmarken die voraussichtlich den
Mindestzugriff erreichen und fuumlr die noch keine
Meldung vorliegt (auf das jeweilige Jahr bezogen) ndash
hinter Bezahlschranke
3713 qualityControlFault
Feld Typ Beschreibung
errorcode int Der Fehlercode In diesem Fall kann nur ein technischer Fehler
(Fehlercode 100) auftreten
errormsg string Grund fuumlr den technischen Fehler
372 Uumlber Maske
Die Qualitaumltskontrolle steht auch uumlber eine Maske (Menuumlpunkt bdquoZaumlhlmarkenstatistikldquo) zur Verfuumlgung
Abbildung 9 Maskenbeschreibung Qualitaumltskontrolle fuumlr Verlage
38 Zugangsbeschraumlnkte Texte
Texte auf zugangsbeschraumlnkten Seiten (mit und ohne Bezahlschranke) koumlnnen gezaumlhlt gemeldet und gegebenenfalls verguumltet werden Es ist in diesem Fall allerdings zwingend erforderlich dass der VG WORT ein f reier Zugang auf die fraglichen Seiten gewaumlhrt wird
Der Zugang kann entweder uumlber ein entsprechendes Benutzerkonto mit vorheriger Anmeldung oder durch die Freischaltung der Texte fuumlr Zugriffe aus einem definierten Computernetzwerk gewaumlhrt werden
Das Verfahren kann vom Verlag uumlber den Menuumlpunkt bdquoZugriff auf zugangsbeschraumlnkte Inhalte erlaubenldquo selbst gewaumlhlt werden (es koumlnnen auch beide Verfahren nebeneinander bestehen)
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 31 von 39
Bearbeitungsstand final
Abbildung 10 Maskenbeschreibung Zugriff auf zugangsbeschraumlnkte Inhalte erlauben
Die Meldung von Texten hinter einer Bezahlschranke ist ohne Anlage eines Benutzerkontos nicht moumlglich
Um der VG WORT zu Pruumlfungszwecken den Zugriff auf die kostenpflichtigen Texte zu ermoumlglichen muss der VG WORT ein passendes Benutzerkonto bekannt gemacht werden oder der Verlag muss die VG WORT auf technischer Ebene fuumlr den Zugriff freischalten (zB IP Adresse)
Unabhaumlngig von der Wahl des Zuganges muss der Verlag sicherstellen dass die VG WORT damit auf alle gezaumlhlten bzw gemeldeten Inhalte zugreifen kann Bei der Auswahl bdquoBenutzerkontoldquo ist zu beruumlcksichtigen dass pro Verlag nur ein Zugang angegeben werden kann
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 32 von 39
Bearbeitungsstand final
4 Technische Verfahren Web Services
41 Authentifizierung
Die Authentifizierung fuumlr das Web Service erfolgt uumlber den Standard bdquoRFC 2617 HTTP Authentication Basic and Digest Accessldquo (siehe httpwwwietforgrfcrfc2617txt) Es wird das einfache bdquoBasicldquo Verfahren verwendet wobei der Benutzername und das Passwort in Klartext mit dem Request gesendet werden Da aber die Verbindung ausschlieszliglich uumlber das SSL-Protokoll laumluft (siehe 42 Datensicherheit) werden diese Felder ohnehin geschuumltzt (verschluumlsselt)
411 Autorisierungs- Authentifizierungsfehler
Wie im TOM Portal unterscheidet man ob ein Benutzer wirklich der Benutzer ist fuumlr den er sich ausgibt (Authentifizierung HTML-Fehlercode 401) und welche Rechte ein Benutzer hat (Autorisierung HTML-Fehlercode 403) In beiden Faumlllen wird vom System der zugehoumlrige HTML-Fehlercode an den Client zuruumlckgesendet
42 Datensicherheit
Um die Daten die waumlhrend der Aktion uumlbermittelt werden zu schuumltzen ist das Web Service nur uumlber den Standard HTTP SSL-Port erreichbar Hierbei werden alle ausgetauschten Daten verschluumlsselt uumlbermittelt Die Authentifizierung des Servers gegenuumlber dem Client geschieht uumlber ein Zertifikat
43 Versionierung
Sollte es Erweiterungen in der Schnittstelle geben wird eine neue Version der entsprechenden Schnittstelle bereitgestellt ndash die alte Version wird jedenfalls weiter unterstuumltzt Die Versionierung des Web Services erfolgt uumlber die URL Im Fall der pixelOrder wuumlrde Version 10 unter folgenden Adresse erreichbar sein
ltDomaumlnennamegtservices10pixelOrder
Version 11
ltDomaumlnennamegtservices11pixelOrder
44 Nachrichten Ablauf
Grundsaumltzlich unterscheidet man bei einem Web Service zwischen 3 Nachrichten Typen - Request - Response - Fault
Ein Request beinhaltet alle Parameter die fuumlr den Aufruf einer Operation notwendig sind Ein Response beinhaltet das Resultat welches fuumlr eine Operation definiert ist Tritt ein Fehler (falsche Parameter Client bzw Server Probleme) waumlhrend der Operation auf wird ein Fault gesendet
Der Ablauf ist in unten stehendem Diagramm noch einmal an Hand einer Zaumlhlmarkenbestellung skizziert
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 33 von 39
Bearbeitungsstand final
Verlag VG Wort
orderPixelRequest
orderPixelResponse
Verlag VG Wort
orderPixelRequest
orderPixelFault
checkConditions
performOrder
checkConditions
Erfolgreiche Bestellung Nicht erfolgreiche Bestellung
a) b)
Abbildung 11 Sequenzdiagramm Zaumlhlmarkenbestellung
Die Antwort (Response oder Fault) von einem Web Service Aufruf muss immer abgewartet werden bevor ein neuer Aufruf gemacht wird Ansonsten kommt es zu technischen Fehlern Beispiel Abwarten des Response einer Zaumlhlmarkenbestellung bevor eine weitere Bestellung abgesendet wird
45 Testsystem
Falls Sie die Schnittstellen vor Inbetriebnahme testen moumlchten wenden Sie sich bitte an metissupportvgwortde um einen temporaumlren Zugriff auf ein Testsystem zu erhalten
Die Daten des Testsystems werden periodisch geloumlscht Zaumlhlmarken die im Testsystem bestellt werden sind unguumlltig und koumlnnen nicht zu einer Ausschuumlttung fuumlhren
46 Probleme im Umgang mit Apache AXIS (ADB)
Im Zusammenhang mit Apache AXIS hat es in der Vergangenheit vermehrt Probleme gegeben Daher wird fuumlr Apache AXIS eine eigene WSDL zur Verfuumlgung gestellt die unter dem Menuumlpunkt bdquoWebServicesldquo heruntergeladen werden kann Diese WSDL beinhaltet folgende Pruumlfungen nicht mehr (diese muumlssen selbst implementiert werden da ansonsten ein serverseitiger Fehler auftritt)
- Es muss mindestens ein Autor oder ein Uumlbersetzer pro Text angegeben werden - Jeder Autor Uumlbersetzer muss entweder uumlber Kuumlrzel oder Vorname + Nachname oder
Vorname + Nachname + Karteinummer gemeldet werden
Wenn Java Klassen mit Apache AXIS aus der WSDL automatisch generiert werden so ist darauf zu achten dass beim Generieren unbedingt die Option bdquo-wldquo mitgegeben wird da ansonsten die Strukturen durch AXIS vereinfacht werden und nicht mehr funktionieren
47 Beispiele fuumlr Web Service Aufrufe
In diesem Kapitel finden Sie pro Web Service ein SOAP XML Beispiel
471 PixelService
4711 Zaumlhlmarken bestellen
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 34 von 39
Bearbeitungsstand final
ltsoapenvBodygt
ltns1orderPixelRequest xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1countgt3ltns1countgt
ltns1orderPixelRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOrderResponse xmlnsns1=httpvgwortde10PixelServicexsdgt
ltns1domaingtvg03metvgwortdeltns1domaingt
ltns1orderDateTimegt200901301320ltns1orderDateTimegt
ltns1pixelsgt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae43
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae44
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1pixel publicIdentificationId=1a0188bb8d79c57d4e215ec423caae47
privateIdentificationId=1a0188bb8d79c57d4e215ec423caae45 gt
ltns1pixelsgt
ltns1pixelOrderResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4712 Zaumlhlmarkenuumlbersicht
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewRequest xmlnsns1=httpvgwortde10PixelServicexsd
offset=0 type=MINDESTZUGRIFFgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1pixelOverviewResponse xmlnsns1=httpvgwortde10PixelServicexsd
amount=1 offset=0 gt
ltns1privateIdentificationIdgt1a0188bb8d79c57d4e215ec423caae43
ltns1privateIdentificationIdgt
ltns1pixelOverviewResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
472 MessageService
4721 Meldung uumlbermitteln
Client -gt Server
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageRequest
xmlnsns1=httpvgwortde113MessageServicexsd
privateidentificationid=1a0188bb8d79c57d4e215ec423caae43 gt
ltns1partiesgt
ltns1authorsgt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 35 von 39
Bearbeitungsstand final
ltns1authorgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1cardNumbergt7654321ltns1cardNumbergt
ltns1authorgt
ltns1authorWithoutContract
transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1messagetext lyric=truegt
ltns1shorttextgtUumlberschriftltns1shorttextgt
ltns1textgt
ltns1plainTextgt11000000011101110001ltns1plainTextgt
ltns1textgt
ltns1messagetextgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttpwwwmusterde1htmlltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1newMessageRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1newMessageResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4722 Qualtiaumltskontrolle
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1qualityControlRequest
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 36 von 39
Bearbeitungsstand final
ltns1qualityControlResponse orderedPixelTillToday=22500
startedPixelTillToday=18500 startedPixelTillTodayFree=13500
startedPixelTillTodayPaid=5000 gt
ltns1qualityControlValues month=3 year=2018
orderedPixel=11000 startedPixel=10000 startedPixelFree=8500
startedPixelPaid=1500 minAccess=8300 minAccessFree=7400
minAccessPaid=900 minAccessNoMessage=14 minAccessNoMessageFree=10
minAccessNoMessagePaid=4gt
ltns1qualityControlValues month=4 year=2018
orderedPixel=12000 startedPixel=10300 startedPixelFree=8500
startedPixelPaid=1800 minAccess=8600 minAccessFree=7700
minAccessPaid=900 minAccessNoMessage=16 minAccessNoMessageFree=13
minAccessNoMessagePaid=3gt
ltns1qualityControlValues month=5 year=2018
orderedPixel=13000 startedPixel=11200 startedPixelFree=9000
startedPixelPaid=2200 minAccess=9000 minAccessFree=8100
minAccessPaid=900 minAccessNoMessage=22 minAccessNoMessageFree=16
minAccessNoMessagePaid=6gt
ltns1qualityControlValues month=6 year=2018
orderedPixel=14000 startedPixel=12000 startedPixelFree=9500
startedPixelPaid=2500 minAccess=9400 minAccessFree=8500
minAccessPaid=900 minAccessNoMessage=31 minAccessNoMessageFree=20
minAccessNoMessagePaid=11gt
ltns1qualityControlValues month=7 year=2018
orderedPixel=15000 startedPixel=12800 startedPixelFree=10000
startedPixelPaid=2800 minAccess=9700 minAccessFree=8800
minAccessPaid=900 minAccessNoMessage=30 minAccessNoMessageFree=15
minAccessNoMessagePaid=15gt
ltns1qualityControlValues month=8 year=2018
orderedPixel=16000 startedPixel=13700 startedPixelFree=10500
startedPixelPaid=3200 minAccess=10100 minAccessFree=9200
minAccessPaid=900 minAccessNoMessage=41 minAccessNoMessageFree=18
minAccessNoMessagePaid=23gt
ltns1qualityControlValues month=9 year=2018
orderedPixel=17000 startedPixel=14500 startedPixelFree=11000
startedPixelPaid=3500 minAccess=10300 minAccessFree=9400
minAccessPaid=900 minAccessNoMessage=33 minAccessNoMessageFree=23
minAccessNoMessagePaid=10gt
ltns1qualityControlValues month=10 year=2018
orderedPixel=18000 startedPixel=15300 startedPixelFree=11500
startedPixelPaid=3800 minAccess=10700 minAccessFree=9800
minAccessPaid=900 minAccessNoMessage=17 minAccessNoMessageFree=12
minAccessNoMessagePaid=5gt
ltns1qualityControlValues month=11 year=2018
orderedPixel=19000 startedPixel=16100 startedPixelFree=12000
startedPixelPaid=4100 minAccess=11200 minAccessFree=10300
minAccessPaid=900 minAccessNoMessage=46 minAccessNoMessageFree=34
minAccessNoMessagePaid=12gt
ltns1qualityControlValues month=12 year=2018
orderedPixel=20000 startedPixel=16900 startedPixelFree=12500
startedPixelPaid=4400 minAccess=11600 minAccessFree=10700
minAccessPaid=900 minAccessNoMessage=49 minAccessNoMessageFree=35
minAccessNoMessagePaid=14gt
ltns1qualityControlValues month=1 year=2019
orderedPixel=21000 startedPixel=17700 startedPixelFree=13000
startedPixelPaid=4700 minAccess=7500 minAccessFree=7400
minAccessPaid=100 minAccessNoMessage=15 minAccessNoMessageFree=12
minAccessNoMessagePaid=3gt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 37 von 39
Bearbeitungsstand final
ltns1qualityControlValues month=2 year=2019
orderedPixel=22000 startedPixel=18500 startedPixelFree=13500
startedPixelPaid=5000 minAccess=7800 minAccessFree=7400
minAccessPaid=400 minAccessNoMessage=29 minAccessNoMessageFree=14
minAccessNoMessagePaid=15gt
ltns1qualityControlResponsegt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4723 Autorenpruumlfung
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorRequest
xmlnsns1=httpvgwortde113MessageServicexsd
cardNumber=12345 surName=Test firstName=rdquoUserrdquo gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1checkAuthorResponse
xmlnsns1=httpvgwortde113MessageServicexsd
valid=false gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
4724 Meldungsrecherche
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesRequest
xmlnsns1=httpvgwortde113MessageServicexsd
offset=0gt
ltns1titlegtIVltns1titlegt
ltns1 researchMetisMessagesRequest gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Server -gt Client
ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1researchMetisMessagesResponse
xmlnsns1=httpvgwortde113MessageServicexsd amount=1 offset=0gt
ltns1ResearchedMetisMessagegt
ltns1messageTypegtMETIS-Meldungltns1messageTypegt
ltns1titlegtIV im Wandelltns1titlegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 38 von 39
Bearbeitungsstand final
ltns1publicidentificationidgt72f489811a994a6abf1aebc946a06896
ltns1publicidentificationidgt
ltns1privateidentificationidgtdff9034bedc747f9ad8ddcabf828e26e
ltns1privateidentificationidgt
ltns1createdDategt2015-10-19T153700000+0200
ltns1createdDategt
ltns1partiesgt
ltns1authorsgt
ltns1authorgt
ltns1firstNamegtReneltns1firstNamegt
ltns1surNamegtRassnitzerltns1surNamegt
ltns1authorgt
ltns1authorWithoutContract transferOfRights=truegt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermannltns1surNamegt
ltns1birthdaygt19031990ltns1birthday gt
ltns1streetgtOberstraszligeltns1streetgt
ltns1houseNumbergt12altns1houseNumbergt
ltns1postCodegt12345ltns1postCodegt
ltns1citygtOberortltns1citygt
ltns1countryCodegtDEltns1countryCodegt
ltns1authorWithoutContractgt
ltns1authorsgt
ltns1partiesgt
ltns1webrangesgt
ltns1webrangegt
ltns1urlgthttptest1deltns1urlgt
ltns1webrangegt
ltns1webrangesgt
ltns1ResearchedMetisMessagegt
ltns1researchMetisMessagesResponse gt ltsoapenvBodygt
ltsoapenvEnvelopegt
4725 Ergaumlnzung gemeldeter Beteiligter
Client -gt Server ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantRequest xmlns=httpvgwortde113Message
Servicexsd xmlnsS=httpschemasxmlsoaporgsoapenvelope privateidentific
ationid=72f489811a994a6abf1aebc946a06896gt
ltns1participantsgt
ltns1participantgt
ltns1firstNamegtMaxltns1firstNamegt
ltns1surNamegtMustermanltns1surNamegt
ltns1cardNumbergt950ltns1cardNumbergt
ltns1participantgt
ltns1participantsgt
ltns1updateMessageParticipantRequestgt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt
Integrationsbeschreibung
METIS fuumlr Verlage
______________________________________________________________________
Dokumentversion 220 Seite 39 von 39
Bearbeitungsstand final
Server -gt Client ltxml version=10 encoding=UTF-8gt
ltsoapenvEnvelope
xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt
ltsoapenvBodygt
ltns1updateMessageParticipantResponse status=OK
xmlnsns1=httpvgwortde113MessageServicexsd gt
ltsoapenvBodygt
ltsoapenvEnvelopegt