editor
725
edits
Changes
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..."
{{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. 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=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=languageCode
|ParamType=String
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=component
|ParamType=String
|ParamRequired=required
|ParamDescription=
}}
|Returns=
Returns a JSON object containing an array of [[LiveChannel]].
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>:
:: [ <span style="color: #219;">Array of [[LiveChannel]] objects</span> ]
}
|Exceptions=
|Cache=
This method cached. The cache is configured in the MIB config files.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.3
{{!}} Initial method design
{{!}} Pablo Antolin and Julio Vasconcelos
{{!}}}
|SeeAlso=
}}
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=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=languageCode
|ParamType=String
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=component
|ParamType=String
|ParamRequired=required
|ParamDescription=
}}
|Returns=
Returns a JSON object containing an array of [[LiveChannel]].
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>:
:: [ <span style="color: #219;">Array of [[LiveChannel]] objects</span> ]
}
|Exceptions=
|Cache=
This method cached. The cache is configured in the MIB config files.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.3
{{!}} Initial method design
{{!}} Pablo Antolin and Julio Vasconcelos
{{!}}}
|SeeAlso=
}}
