The Web services allow applications to work with documents using the Simple Access Object Protocol (SOAP) running over HTTP/HTTPS.
Web services are documented using a Web Services Description Language (WSDL) document that provides a mechanism to describe a machine-readable Web service including its operations, inputs, outputs, and faults.
The WSDL provided with Lotus Quickr conforms with the WS-I Basic Profile and enables broad tooling support for working with the services. Development tooling can consume the WSDL and generate code to interact quickly with the remote service definition.
Unlike the REST-based services, the client application invokes each Web service operation using SOAP, which defines a mechanism for exchanging XML over a network.
You can retrieve the WSDL describing these services from a Lotus Quickr server.
The WSDL defines three service endpoints for interacting with document content in Lotus Quickr. An overview describing the intent of each service endpoint is provided below. Refer to the WSDL for detailed documentation on each service and operation.
Content service. The ContentService endpoint groups together a set of generic model-type independent operations. The service provides operations for retrieving information about a user, group of users, or the server environment and service version that is deployed on the Lotus Quickr server.
Library service. The LibraryService endpoint groups together a set of operations for retrieving business component libraries from the Lotus Quickr server. For Lotus Quickr 8.0, there is only support for retrieving document management libraries.
Document service. The DocumentService endpoint groups together a set of operations for manipulating document management resources. Operations are defined for creating, retrieving, updating, and deleting document management resources and their associated metadata. In addition, operations are available for moving resources, approving and rejecting resources, etc.
In order to interact with the Web service endpoints defined, the client agent must authenticate with the service using Basic Authentication.
There are two types of error responses that are returned from the Web services. SOAP Faults are thrown for unrecoverable or unexpected errors. For all other error types, error responses are nested in the complex type in the operations output message that includes an error code and message. This requires developers to look for both types of errors when coding against the services.
Best practices and recommendations
Here we discuss best practices and recommendations.
Binary content transfer. There is no support in the services to transfer binary content in a SOAP request or response. In order to modify binary resources, use the REST services described in this document for media transfer.
Each resource type that exposes a corresponding binary resource has an attribute that addresses how to download that binary resource for developer convenience via a separate HTTP request.
Id / Path / Id and Path offset. Each service call that addresses a resource supports the caller's ability to address the resource via a unique identifier or a path. If a caller passes both an identifier and a path, the service implementation will treat the identifier as the base, and treat the path as a relative offset to the ultimate resource.
For performance, it is recommended to reference a resource via the unique identifier over the path.
Operations in the Web services support a number of service options to customize the amount of information that is returned from the server for a client request. It is recommended that clients only request the minimum amount of information needed to optimize server performance. For a list of service options and their associated behavior supported by each operation, consult the WSDL documentation