Web services for administration expose a limited set of JasperReports Server’s system administration functionality. There are three services:

The services work via XML-RPC calls that use the SOAP encoding. They use the HTTP protocol to send and receive requests and responses. By default, they are deployed at /services/UserAndRoleManagementService, /services/OrganizationManagementService, and /services/PermissionsManagementService. You can retrieve the WSDL documents by appending ?wsdl to the service URL. For example:

http://localhost:8080/jasperserver-pro/services/UserAndRoleManagementService?wsdl

If an exception occurs while processing an operation request, the exception is converted to a SOAP fault that is sent as its response. In this case, the exception stacktrace is included in the response, which can be useful for debugging.

Exceptions thrown by JasperReports Server have localizable messages. The operation caller can specify the locale in which the messages of such exceptions are returned by setting a SOAP envelope header. The header should be named locale and should use http://www.jasperforge.org/jasperserver/ws as its namespace; the header value is a string representation of the desired message locale. For more information, refer to section Request and Operation Result.

All authentication and authorization rules established in the system apply to operations run through the web services. Refer to Jasper Administrator Guide for more information about the rules.

This chapter includes the following sections: