← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 950: Configuration section

 

------------------------------------------------------------
revno: 950
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2014-01-31 09:54:06 +0200
message:
  Configuration section
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-01-23 09:45:45 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-01-31 07:54:06 +0000
@@ -3812,6 +3812,39 @@
       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>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>
+    <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>Configuration</title>
+    <para>To access configuration you can interact with the <emphasis role="italic"
+        >configuration</emphasis> resource. You can send <emphasis role="italic">GET</emphasis>
+      requests to the following sub-resources. You can get XML and JSON responses through the
+        <emphasis role="italic">Accept</emphasis> header or by using the .json or .xml
+      extensions.</para>
+    <screen>/api/configuration/systemId
+/api/configuration/feedbackRecipients
+/api/configuration/offlineOrganisationUnitLevel
+/api/configuration/infrastructuralDataElements
+/api/configuration/infrastructuralPeriodType
+/api/configuration/selfRegistrationRole
+/api/configuration/selfRegistrationOrgUnit</screen>
+  </section>
+  <section>
     <title>Translations</title>
     <para>In order to retrieve key-value pairs for translated strings you can use the <emphasis
         role="italic">i18n</emphasis> resource. The endpoint is located at <emphasis role="italic"
@@ -3831,24 +3864,6 @@
 }</screen>
   </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>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>
-    <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>SVG conversion</title>
     <para>The Web API provides a resource which can be used to convert SVG content into more widely
       used formats such as PNG and PDF. Ideally this conversion should happen on the client side,