...
<value><struct>
<member>
<name>__objtype</name>
<value>Dictionary</value>
</member>
<member>
<name>id</name>
<value>4212</value>
</member>
<member>
<name>name</name>
<value>My Dictionary</value>
</member>
<member>
<name>description</name>
<value>A test dictionary</value>
</member>
</struct></value>
Methods
| Method name | Arguments | Returns | Description |
|---|---|---|---|
| getTermWebVersion | None | Version string | Returns the version string from TermWeb |
| initSession | None | Session ID | Creates a session as auto-login guest |
| initSession | client, user, password | Session ID | Creates a session as for specified client and user |
| close | sessionID | - | Closes the session |
| getAll | sessionID, object type | Array of TermWeb objects | Retrieves all available objects of specified type. The possible types are dictionary, domain |
| setAllSelected | sessionID, object type | - | Selects all available objects of specified type. The possible types are section, domain |
| setSelected | sessionID, object type, ID | - | Select object with specified type and ID. The possible types are dictionary, language, domain, section |
| setSelected | sessionID, object type, array of IDs | - | Select all objects with specified type and IDs. The possible types are domain, section |
| getSelected | sessionID, object type | The selected object | Returns the selected object of specified type. The possible types are dictionary |
| getIndexTerms | sessionID, search string | A list of index terms | Returns the index terms that matches the search expression. |
| getIndexTerms | sessionID, search condition map | A list of index terms | Returns the index terms that matches the search conditions |
| getIndexTerms | sessionID, search condition map, target language | A list of index terms | Returns index terms for the specified target language corresponding to the index terms that matches the search conditions |
| getConceptEntry | sessionID, conceptEntryID | A concept entry | Returns the concept entry with specified ID. |
| getSourceLanguage | sessionID | A language code | Returns the ISO 639-2 language code for the currently selected source language |
| setSourceLanguage | sessionID, language code | - | Sets the currently selected source language |
| getObject | sessionID, object type, id | A TermWeb object | Returns the object with specified type and id |
| getObjectByName | sessionID, object type, name | A TermWeb object | Returns the object with specified type and name |
| create | sessionID, object | - | Creates a new TermWeb object in the current context |
Error handling
If an error occurs during processing of a method, an error message containing a description of the error together with an error code is returned.
Example: Failed to invoke method getAll in class org.termweb.api.internal.XmlRpcReceiver: The session has expired. (Code:1300)
The errors and codes are as follows:
...
The client account is disabled
...