|
|
|
|
|
|
|
|
|
|
|
|
|
|
Building a Content Management System using Lotus Domino: a tour of the XML API (continued)
The easiest way to bring the message across is to jump straight ahead and show you the final XML API arising from the design and specification process. Here it is.
The XML API
Here's a rundown of the entire XML API, an example of how to use it, and a description of its purpose.
Click on the example links to see the XML output returned from each API call. I have had the most success with viewing XML documents using Internet Explorer version 6. If you can't see the XML that is returned, try using a different browser.
(XMLSiteConfiguration)/site+configuration
(XMLSiteConfiguration)/site+configuration returns all global settings and other configuration information applying to the site. There are no parameters.
The example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLSiteConfiguration)/site+configuration.
(XMLDBLastModified)
(XMLDBLastModified) returns the current server date and time and the date and time that the database was last modified. There are no parameters.
The example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLDBLastModified).
(XMLCategories)
Each document in the site can have up to three levels of categorization. (XMLCategories) returns a list of all document categories in the site. There are no parameters.
The example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLCategories).
(XMLMainMenu)
(XMLMainMenu) returns the menu structure for the site. It requires text parameter "searchfor".
The example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLMainMenu).
(XMLFulltextSearch)?openagent&searchfor=
(XMLFulltextSearch)?openagent&searchfor= executes a full text search and returns any matching documents. It requires text parameter "searchfor".
The example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLFulltextSearch)?openagent&searchfor=.
The format of the Full Text Search XML DTD (Document Type Definition) is exactly the same as that of the XML Site Index DTDs (see below). This makes the returned data suitable for formatting and display using the same code used for displaying XML Site Indexes.
(XMLContent)/[document unique id]
(XMLContent)/[document unique id] returns all of a content document. It requires text parameter "searchfor" and requires the document unique ID as a parameter.
The example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLContent)/970DC363D8EA3ABECA25690B0033E0A2.
(XMLTextProperties)/[text properties name]
(XMLTextProperties)/[text properties name] returns the specified text properties scheme. It requires the name of text properties scheme.
An example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLTextProperties)/gamepresstextproperties.
Another example can be found at http://domino.touchdown.com.au/dpsg.nsf/(XMLTextProperties)/tdtp.
Site indexes
A "site index" is a list of all documents in the site, including archived documents. A site index only includes content documents, not other document types such as menu items or text properties schemes.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
-- Advertisement --
Sophisticated Meets Simple For Document Management
Share. Control. Manage.
Documents, emails, and content in the context of how work is done.
Native to Lotus Domino. The User Experience unseen for Lotus Domino.
Do more with less. Really.
See the possibilities Docova unleashes for Lotus Domino. |
-- Advertisement --
Mark your calendar for in-depth Lotus training, May 12-14, Boston
Join experts and peers May 12-14 in Boston for educational and networking events that deliver real-world Lotus training so you can increase productivity and efficiency in your company, advance your skills, and squeeze the most from your current environment. One registration gets you into THE VIEW's Admin2010 and Lotus Developer2010.
Register by April 10 to save $200. |
|
|
|
|
|
|
|
|
|
|
