Documentation Center

Load menu XML

Loads a XML menu resource from the etc/menus directory. This menu resource will be found at the file location defined by the app.docs_root configitem in the wietmsd.xml configuration. All menu resources are in XML format. The client is responsible for choosing the correct menu to load, either the publication-specific menu (PUB_NAME_menu.xml), the DTD-specific menu (DTD_NAME_menu.xml) or the catch-all menu.xml.

Example API call

/servlets3/wietmsd?id=1459258522338&date=1459947343895&target=resource&action=menu&file_name=s1000d_button_menu.xml

Parameters

ParameterDescription
targetresource
actionmenu
file_nameThe full name of the XML menu file to load, such as menu.xml or s1000d_button_menu.xml.
idA session ID that is valid for this collection and publication combination.
dateTo prevent browser-side caching of data, especially with AJAX requests, it is important to make a URL unique. The most effective technique to accomplish this is to include a time parameter that is based on the time at which the call is made.

Returns

On success
The XML content of the menu file.
On failure
A message indicating that the requested XML file was not found.