Web Service Parameters

When a web service is called, parameters can be passed to the web services via data structures. The parameters are defined with the XML Schema Definition (XSD) language. The parameters for the SOAP and RESTful web services are identical.


In the case of SOAP web services, the parameters are passed as XML structures to the web services. For the RESTful web services, the parameters are passed to the JSON structures.



The data structure that is passed as arguments to the web services is described by the http://schema.webpdf.de/1.0/operation.xsd schema.


The general definition for the XML schema can be found at https://www.w3.org/XML/Schema. webPDF uses Version 1.0 of the schema to define the web service parameters.


The following documents go over the parameters for the individual web services. They only describe the parameters for the web services without providing the additional data structures (or control structures) for the SOAP and REST calls.


The description features an example of an overall XML structure for the individual web service and the corresponding JSON structure. The web service’s individual parameters are listed only as an XML structure. The corresponding JSON structures need to be adjusted (please refer to http://localhost:8080/webPDF/help/restful/).


Wrapper classes


Most environments (programming languages and applications) that can work with web services feature an import interface for SOAPful and RESTful web services. These interfaces are responsible for generating the corresponding proxy classes ("client stubs") for the relevant environment. These proxy classes, in turn, make it possible to call web services with arguments without having to manually create the direct XML or JSON structures.