← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1005: User settings

 

------------------------------------------------------------
revno: 1005
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Thu 2014-04-03 14:44:05 +0200
message:
  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	2014-04-03 07:19:12 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-04-03 12:44:05 +0000
@@ -3948,9 +3948,12 @@
     <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>
+      authenticated for the Web API request. To save or update a setting for the currently
+      authenticated user 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 can specify the user for which to save the setting explicitly with this syntax:</para>
+    <screen>/api/userSettings/my-key?user=user-id&amp;value=my-val</screen>
     <para>Alternatively, you can submit the setting value as the request body, where content type is
       set to "text/plain". As an example, you can use curl like this:</para>
     <screen>curl "apps.dhis2.org/demo/api/userSettings/my-key" -d "My long value" -H "Content-Type: text/plain" -u admin:district -v</screen>