Difference between revisions of "GetDictionary"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Get the complete dictionary for a component based on the chosen language. The dictionary is the translation for all words used in each component. E...") |
|||
| Line 29: | Line 29: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing | + | Returns a JSON object containing objects with whole dictionary grouped by section in pair key/value. |
'''Example:''' | '''Example:''' | ||
| Line 38: | Line 38: | ||
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | ||
: <span style="color: #a11;">"Content"</span>: | : <span style="color: #a11;">"Content"</span>: | ||
| − | :: | + | :: { |
| + | ::: <span style="color: #219;">"alert": { | ||
| + | :::: "buttonclose": "Fechar", | ||
| + | :::: "cancel": "Cancelar", | ||
| + | :::: "ok": "OK" | ||
| + | ::: }</span> | ||
| + | :: } | ||
} | } | ||
Revision as of 14:59, 9 June 2014
Description
Get the complete dictionary for a component based on the chosen language. The dictionary is the translation for all words used in each component. Each words (key) is replicated in each language available on the environment as specified in the MIB config file.
The translation of the files is made by MIB Tools and it has a configurable cache to be reflex in the UNIAPI.
Parameters
- deviceType (int, required)
- languageCode (String, required)
- component (String, required)
Returns
Returns a JSON object containing objects with whole dictionary grouped by section in pair key/value.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content":
- {
- "alert": {
- "buttonclose": "Fechar",
- "cancel": "Cancelar",
- "ok": "OK"
- }
- "alert": {
- }
- {
}
Exceptions
Caching
This method cached. The cache is configured in the MIB config files.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.3 | Initial method design | Pablo Antolin and Julio Vasconcelos |
