Documentation Center

Get Help page URL by help ID

Returns the URL to access the help page, which is identified by a numerical help ID.

The help ID and the corresponding page are set in the wietmsd_prg.xml configuration file using a configuration item named help.HELP_ID, where HELP_ID is the help ID. The following example shows a configuration item with the help ID 1001.

<configitem name="help.1001">
     <comments>Book list</comments>
     <value>/help/Choosing_a_Technical_Manual.htm</value>
</configitem>

Example API call

/servlets3/wietmsd?id=1460015059941&time=135132123123&target=tools&action=show_help&location=1001

Parameters

ParameterDescription
targettools
actionshow_help
locationThe requested help ID
idA session ID that was retrieved with or without a specific collection and publication combination
timeTo 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
<RESULT>
     <URL>/wietmsd3/help/Choosing_a_Technical_Manual.htm</URL>
</RESULT>
On failure
Returns nothing