Get Help URL by name

Returns the URL to access a help page that is identified by name. There are a group of 4 help pages that are named and can be accessed through this API call, by changing the value of the action parameter.

Example API call

/lcapi?book=1&collection=1&target=btnbar&action=get_releasenotes

Parameters

ParameterDescription
targetbtnbar
action
One of the following:
get_contents
retrieves the URL stored in the <configitem name="ietm.help_url" />
get_about
retrieves the URL stored in the <configitem name="ietm.about_url" />
get_company
retrieves the URL stored in the <configitem name="ietm.company_url" />
get_releasenotes
retrieves the URL stored in the <configitem name="ietm.release_notes" />
bookThe id of the publication, an integer, such as 1.
collection The id of the collection, an integer, such as 1.

Returns

On success
<RESULT>
     <URL>/lcapi/releasenotes/releasenotes.html</URL>
</RESULT>
On failure
HTML page reporting that an unsupported transaction has been called.