Product Documentation articleAPI conventions: lq851
Added by IBM contributorRui BJ Yang | Edited by IBM contributorDana Liburdi on July 14, 2011 | Version 5
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.

The IBM Lotus Quickr Documents interfaces allow you to access and update the same information you can access and update in the Quickr web and connector user interfaces. The application programming interfaces (APIs) are access over HTTP so they can work over your network from any program that can send and receive HTTP.

To retrieve information from the services to use in your own applications, you use a "feed" to retrieve the data. A "feed" is a special data format optimized for retrieving information that may change over time. The information in a document library is an obvious example of a feed – each time a new folder or document is added to the library, the feed for the library will indicate what has been changed. The API uses the Atom format for providing information your programs can retrieve.

XML is used as the data format for Atom, so you can use this API from any program that can send and receive XML over HTTP. Your program can process the XML itself, or use a program such as Apache Xerces, or Apache Abdera, to make the job easier. In addition, the API allows programs to create new information in the services, and update existing information using the Atom Publishing Protocol. This version of the API conforms to RFC 5023 Atom Publishing Protocol, with Quickr-specific extensions as allowed by the standard.

For compatibility, please note that the Atom Publishing Protocol defines an XML namespace,, for use with data elements related to publishing operations. Earlier releases of the Connections API used a namespace from a previous draft of the protocol, The draft namespace continues to be accepted on input, however it is deprecated and will be eliminated in a future release. Output from the API uses the new namespace. Please make sure your programs are able to handle either namespace. If you use Apache Abdera, it will handle this change for you.

To perform an action against the API, you need to invoke an HTTP command (GET, PUT, POST, DELETE) on a resource with a set of potential URL arguments and HTTP headers to toggle the default behavior of the command. Each resource type is fully documented in its details pages. Sample XML markup is provided to allow you to easily understand the Atom entry formats utilized. Sample interaction with each network resource is provided in the details page for each described operation. This interaction includes the list of supported URL arguments, HTTP headers, request formats, request responses, and error codes.