{"openapi":"3.1.0","info":{"title":"Portalverbund - Konverter REST-API","description":"Das Portalverbund-Onlinegateway (PVOG) stellt zentral die Verwaltungsleistungen von Bund und Ländern bereit.\nDie Aufgabe des Konverters ist es, die vollständige Umstellung auf neue XZuFi-Standards zu unterstützen, indem der Dienst XZuFi-Dokumente zwischen verschiedenen XZuFi-Versionen konvertiert.\n\n**Authentifizierung / Autorisierung:**\n\nDie Zugangsdaten erfragen Sie bitte beim Support.\n\nDie Endpunkte des Konverters sind mit OAuth2 abgesichert. Folgende Grant Types werden unterstützt:\n* [Client Credentials](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/)\n\nDie Endpunkte des Konverters kann man in der Swagger-UI folgendermaßen testen:\n1. Den gewünschten REST-Endpunkt auswählen\n2. Auf das offene Schloss im rechten Bereich klicken. Es öffnet sich ein Dialog\n3. Im Dialog im Feld *client_id* die vom PVOG zugeteilte \"client-ID\" eingeben und im Feld *client_secret* das zugeteilte client-secret.\n4. Auf den Button \"Close\" klicken. Ab jetzt kann man die REST-Endpunkte in der Swagger-UI nutzen.\n","contact":{"name":"FITKO","url":"https://www.fitko.de/"},"license":{"name":"Creative Commons Attribution Share Alike 4.0 (CC BY-SA 4.0)","url":"https://creativecommons.org/licenses/by-sa/4.0/"},"version":"1.6.6"},"servers":[{"url":"https://stage.pvog.fitko.net/konverter-backend/api","description":"Generated server url"}],"tags":[{"name":"XZuFi-Konverter","description":"Dienst zum Konvertieren von XZuFi-Dokumenten zwischen den Versionen 2.2.0 und 2.3.1.\n"}],"paths":{"/v1/transferoperations/convert":{"post":{"tags":["XZuFi-Konverter"],"summary":"Konvertierung eines XZuFi-Dokumentes von XZuFi-2.2.0 in XZuFi-2.3.1 und umgekehrt.","description":"Konvertiert ein XZuFi-Dokument zwischen XZuFi-2.2.0 und XZuFi-2.3.1. Quell- und Zielversion müssen durch einen \"xzufi-version\"-Parameter in den \"Content-Type\"- und \"Accept\"-Headern übertragen werden. Ist keine Zielversion gesetzt, so wird das Dokument in XZuFi-2.3.1 geliefert, wenn Content-Type auf 2.2.0 gesetzt ist und umgekehrt, falls Content-Type 2.3.1 ist.","operationId":"konvertiereXZuFi","requestBody":{"description":"XML-Dokument im XZuFi-Format","content":{"application/xml;xzufi-version=2.2.0":{"schema":{"type":"string"},"examples":{"XZuFi-Dokument":{"summary":"Ein XML-Dokument nach XZuFi-Standard","description":"Ein XZuFi-Dokument im XZuFi-2.2.0 oder -2.3.1-Format","value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<xzufi:transfer.operation.040502 produktbezeichnung=\"Redsys\" produkthersteller=\"Dataport\" produktversion=\"5.7.0.5\" xzufiVersion=\"2.2.0\" xmlns:xzufi=\"http://xoev.de/schemata/xzufi/2_2_0\">\n    <xzufi:nachrichtenkopf>\n        <xzufi:nachrichtUUID>9bf22a6e-df06-4fe1-b450-5e5ce5ef79f1</xzufi:nachrichtUUID>\n        <xzufi:erstelltDatumZeit>2024-07-22T19:47:14.9679891+02:00</xzufi:erstelltDatumZeit>\n        <xzufi:empfaenger>Portalverbund Sammlerdienst</xzufi:empfaenger>\n        <xzufi:sender>Redaktionssystem</xzufi:sender>\n    </xzufi:nachrichtenkopf>\n    <xzufi:schreibe>\n        <xzufi:leistung>\n        ...\n        </xzufi:leistung>\n    </xzufi:schreibe>\n</xzufi:transfer.operation.040502>\n"}}},"application/xml;xzufi-version=2.3.1":{"schema":{"type":"string"},"examples":{"XZuFi-Dokument":{"summary":"Ein XML-Dokument nach XZuFi-Standard","description":"Ein XZuFi-Dokument im XZuFi-2.2.0 oder -2.3.1-Format","value":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<xzufi:transfer.operation.040502 produktbezeichnung=\"Redsys\" produkthersteller=\"Dataport\" produktversion=\"5.7.0.5\" xzufiVersion=\"2.2.0\" xmlns:xzufi=\"http://xoev.de/schemata/xzufi/2_2_0\">\n    <xzufi:nachrichtenkopf>\n        <xzufi:nachrichtUUID>9bf22a6e-df06-4fe1-b450-5e5ce5ef79f1</xzufi:nachrichtUUID>\n        <xzufi:erstelltDatumZeit>2024-07-22T19:47:14.9679891+02:00</xzufi:erstelltDatumZeit>\n        <xzufi:empfaenger>Portalverbund Sammlerdienst</xzufi:empfaenger>\n        <xzufi:sender>Redaktionssystem</xzufi:sender>\n    </xzufi:nachrichtenkopf>\n    <xzufi:schreibe>\n        <xzufi:leistung>\n        ...\n        </xzufi:leistung>\n    </xzufi:schreibe>\n</xzufi:transfer.operation.040502>\n"}}}},"required":true},"responses":{"200":{"description":"Die Konvertierung war erfolgreich.","headers":{"X-Rate-Limit-Limit":{"description":"Anzahl der maximalen Anfragen pro Zeiteinheit","style":"simple","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversionResponse"},"examples":{"ConversionResponse":{"summary":"Ergebnisobjekt mit Protokoll und Dokument.","description":"Das Konvertierungsergebnis enthält ein Protokoll mit Informationen zum Konvertierungsvorgang und das konvertierte Dokument.","value":{"protokoll":"Der Code 003 existiert in XZuFi-2.3.1 nicht mehr und wurde entfernt.","dokument":"<xzufi:transfer.operation.050502 produktbezeichnung='Redsys' produkthersteller='Dataport' produktversion='5.7.0.5' xzufiVersion='2.3.1' xmlns:xzufi='http://xoev.de/schemata/xzufi/2_3_1'>...</xzufi:transfer.operation.050502>"}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/ConversionResponse"},"examples":{"ConversionResponse":{"summary":"Ergebnisobjekt mit Protokoll und Dokument.","description":"Das Konvertierungsergebnis enthält ein Protokoll mit Informationen zum Konvertierungsvorgang und das konvertierte Dokument.","value":{"protokoll":"Der Code 003 existiert in XZuFi-2.3.1 nicht mehr und wurde entfernt.","dokument":"&lt;xzufi:transfer.operation.050502 produktbezeichnung=&quot;Redsys&quot; produkthersteller=&quot;Dataport&quot; produktversion=&quot;5.7.0.5&quot; xzufiVersion=&quot;2.3.1&quot; xmlns:xzufi=&quot;http://xoev.de/schemata/xzufi/2_3_1&quot;&gt;...&lt;/xzufi:transfer.operation.050502&gt;"}}}}}},"400":{"description":"Die Konvertierungsanfrage enthält unzulässige Anfrageparameter, das Dokument entspricht nicht dem XZuFi-Schema, ein Virus wurde erkannt oder die XZuFi-Versionen werden nicht unterstützt.","headers":{"X-Rate-Limit-Limit":{"description":"Anzahl der maximalen Anfragen pro Zeiteinheit","style":"simple","schema":{"type":"integer"}}}},"401":{"description":"Es fehlt die notwendige Berechtigung für die Anfrage","headers":{"X-Rate-Limit-Limit":{"description":"Anzahl der maximalen Anfragen pro Zeiteinheit","style":"simple","schema":{"type":"integer"}}}},"500":{"description":"Request konnte aufgrund eines unbekannten Fehlers nicht verarbeitet werden."}},"security":[{"pvog_auth":[]}]}}},"components":{"schemas":{"ConversionResponse":{"type":"object","properties":{"protokoll":{"type":"string","description":"Enthält Informationen zum Konvertierungsvorgang.","maxLength":4096},"dokument":{"type":"string","description":"Das konvertierte Dokument.","maxLength":50000000},"informationsverluste":{"type":"array","description":"Informationsverluste","items":{"$ref":"#/components/schemas/Informationsverlust"}}}},"Informationsverlust":{"type":"object","properties":{"transformError":{"type":"string"},"anzahl":{"type":"integer","format":"int32"}}}},"securitySchemes":{"pvog_auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://stage.pvog.fitko.net/auth/realms/pvog/protocol/openid-connect/auth","tokenUrl":"https://stage.pvog.fitko.net/auth/realms/pvog/protocol/openid-connect/token","scopes":{}}}}}}}