Difference between revisions of "GetDictionary"
Jump to navigation
Jump to search
| Line 48: | Line 48: | ||
|Exceptions= | |Exceptions= | ||
| + | * [[MissingRequiredParameterException]] with value: "Language Code is mandatory!". | ||
| + | * [[MissingRequiredParameterException]] with value: "Component is mandatory!". | ||
| + | * [[InvalidComponentException]] | ||
|Cache= | |Cache= | ||
| − | This method cached. The cache is configured in the MIB config files. | + | This method cached. The cache is configured in the MIB config files (MibDictionariesComponents). |
|KnownIssues= | |KnownIssues= | ||
Revision as of 15:02, 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
- MissingRequiredParameterException with value: "Language Code is mandatory!".
- MissingRequiredParameterException with value: "Component is mandatory!".
- InvalidComponentException
Caching
This method cached. The cache is configured in the MIB config files (MibDictionariesComponents).
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.3 | Initial method design | Pablo Antolin and Julio Vasconcelos |
