Resource files of LP are associative arrays, structured like key => value. One key can be equal to different values depending on a locale name. For instance, ui__server/mail__short-title key can be equal to "Mail Server Settings" in US English locale and to "Paramètres du serveur de messagerie" in French locale. To retrieve a key value for a specified locale, use the get-message operation.
A request XML packet retrieving localized messages includes the get-message operation node:
<packet>
<get-message>
<install>
</install>
</get-message>
</packet>
The get-message node is presented by type LocaleGetMessageInput (locale.xsd
), and its graphical representation is as follows:
locale.xsd
).
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
The get-message node of the output XML packet is presented by type LocaleGetMessageOutput (locale.xsd
) and structured as follows:
locale.xsd
).
The following request packet retrieves value for the ui__server/mail__short-title key in US English locale:
<packet>
<locale>
<get-message>
<filter>
<key>ui__server/mail__short-title</key>
</filter>
<id>en-US</id>
</get-message>
</locale>
</packet>
Response:
<packet version="1.6.7.0">
<locale>
<get-message>
<result>
<status>ok</status>
<filter-id>ui__server/mail__short-title</filter-id>
<id>en-US</id>
<message>Mail Server Settings</message>
</result>
</get-message>
</locale>
</packet>
If the key was not found, the response is as follows:
<packet version="1.6.7.0">
<locale>
<get-message>
<result>
<status>error</status>
<errcode>1013</errcode>
<errtext>Key does not exist</errtext>
<filter-id>hst_def__fp_admin_login</filter-id>
<id>fr-FR</id>
</result>
</get-message>
</locale>
</packet>
The following request packet retrieves values for the ui__server/mail__short-title and ui__server/mail__description keys in French locale:
<packet>
<locale>
<get-message>
<filter>
<key>ui__server/mail__short-title</key>
<key>ui__server/mail__description</key>
</filter>
<id>fr-FR</id>
</get-message>
</locale>
</packet>
Response:
<packet version="1.6.7.0">
<locale>
<get-message>
<result>
<status>ok</status>
<filter-id>ui__server/mail__short-title</filter-id>
<id>fr-FR</id>
<message>Paramètres du serveur de messagerie</message>
</result>
<result>
<status>ok</status>
<filter-id>ui__server/mail__description</filter-id>
<id>fr-FR</id>
<message>Configurez votre serveur de messagerie et configurez les paramètres de messagerie valables pour l'ensemble du serveur.</message>
</result>
</get-message>
</locale>
</packet>