Webservice Parameter

Beim Aufruf eines Webservices können über Datenstrukturen Parameter an die Webservices übergeben werden. Die Parameter sind über die XML Schema Definition (XSD) Sprache definiert. Die Parameter sind für die SOAP- und RESTful-Webservices identisch.

 

Bei den SOAP-Webservices werden die Parameter als XML-Strukturen an die Webservices übergeben. Bei den RESTful-Webservices werden die Parameter in den JSON-Strukturen übergeben.

 

tipp

Die Datenstruktur, die als Parameter an die Webservices übergeben wird, wird über das Schema http://schema.webpdf.de/1.0/operation.xsd beschrieben.

 

Die allgemeine Definition des XML-Schema befindet sich unter https://www.w3.org/XML/Schema. webPDF verwendet das Schema in der Version 1.0 zur Definition der Webservice-Parameter.

 

In den nachfolgenden Dokumenten werden die Parameter für die einzelnen Webservices beschrieben. Es werden dabei nur die Parameter für den jeweiligen Webservices beschrieben, ohne dabei die zusätzlichen Datenstrukturen (oder Kontrollstrukturen) der SOAP- oder REST-Aufrufe anzugeben.

 

In der Beschreibung befindet sich jeweils ein Beispiel für eine XML-Gesamtstruktur für den einzelnen Webservice und die entsprechende JSON-Struktur. Die einzelnen Parameter des Webservices werden nur als XML-Struktur aufgeführt. Die entsprechenden JSON-Strukturen müssen adaptiert werden (siehe http://localhost:8080/webPDF/help/restful/).

 

Wrapper-Klassen

 

Die meisten Umgebungen (Programmiersprachen oder Anwendungen), die mit Webservices arbeiten können, verfügen über eine Import-Schnittstelle für SOAP- oder RESTful Webservice. Diese Schnittstellen erstellen dann die entsprechenden Proxy-Klassen (sogenannte "client stubs") für die jeweilige Umgebung. Mit diesen lassen sich die Webservices mit den Parametern aufrufen, ohne das die direkten XML- oder JSON-Strukturen manuell erstellt werden müssen.