dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 807
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sun 2013-09-22 16:47:01 +0200
message:
  Web API, user settings
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-09-20 10:55:19 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-09-22 14:47:01 +0000
@@ -2432,15 +2432,30 @@
         >systemSettings</emphasis> resource. A system setting is a simple key-value pair, where both
       the key and the value are plain text strings. To save or update a system setting you can make
       a <emphasis role="italic">POST</emphasis> request to the following URL:</para>
-    <screen>/api/systemSettings/my-key?value=my-value</screen>
-    <para>You should replace my-key with your real key and my-value with your real value. To
-      retrieve the value for a given key in plain text you can make a <emphasis role="italic"
-        >GET</emphasis> request to the following URL:</para>
+    <screen>/api/systemSettings/my-key?value=my-val</screen>
+    <para>You should replace my-key with your real key and my-val with your real value. To retrieve
+      the value for a given key in plain text you can make a <emphasis role="italic">GET</emphasis>
+      request to the following URL:</para>
     <screen>/api/systemSettings/my-key</screen>
     <para>To delete a system setting, you can make a <emphasis role="italic">DELETE</emphasis>
       request to the URL similar to the one used above for retrieval.</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
+      key and the value are plain text strings. The user setting will be linked to the user who is
+      authenticated for the Web API request. To save or update a user setting you can make a
+        <emphasis role="italic">POST</emphasis> request to the following URL:</para>
+    <screen>/api/userSettings/my-key?value=my-val</screen>
+    <para>You should replace my-key with your real key and my-val with your real value. To retrieve
+      the value for a given key in plain text you can make a <emphasis role="italic">GET</emphasis>
+      request to the following URL:</para>
+    <screen>/api/userSettings/my-key</screen>
+    <para>To delete a user setting, you can make a <emphasis role="italic">DELETE</emphasis> request
+      to the URL similar to the one used above for retrieval.</para>
+  </section>
+  <section>
     <title>FRED API</title>
     <para>DHIS 2 from version 2.11 implements support for the current draft
       of the FRED API version 1.0. The project defines itself as <quote>open standard for sharing and updating