← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 921: documented /api/i18n endpoint

 

------------------------------------------------------------
revno: 921
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Mon 2013-12-30 14:14:10 +0100
message:
  documented /api/i18n endpoint
modified:
  src/docbkx/en/dhis2_user_man_web_api.xml


--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs

Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription
=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-27 15:56:51 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-30 13:14:10 +0000
@@ -3575,6 +3575,21 @@
       request to the URL similar to the one used above for retrieval.</para>
   </section>
   <section>
+    <title>I18n Resource</title>
+    <para>This endpoint can be used to get i18n common key (keys that are shared among all our modules). The endpoint is located at
+        <emphasis role="bold">/api/i18n</emphasis> and the format is a simple array of the keys you want looked up, an example is (remember
+      to set content type to <emphasis role="bold"
+      >json</emphasis>):<screen>[
+  "access_denied",
+  "uploading_data_notification"
+]</screen></para>
+    <para>And the result from the server will
+      be:<screen>{
+  "uploading_data_notification":"Uploading locally stored data to the server",
+  "access_denied":"Access denied"
+}</screen></para>
+  </section>
+  <section>
     <title>User settings</title>
     <para>You can manipulate user settings by interacting with the <emphasis role="italic"
         >userSettings</emphasis> resource. A user setting is a simple key-value pair, where both the