dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 881
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sat 2013-12-14 16:00:18 +0100
message:
  Docs on datavalues resource
modified:
  src/docbkx/en/dhis2_user_man_persons_and_programs.xml
  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_persons_and_programs.xml'
--- src/docbkx/en/dhis2_user_man_persons_and_programs.xml	2013-10-21 08:53:52 +0000
+++ src/docbkx/en/dhis2_user_man_persons_and_programs.xml	2013-12-14 15:00:18 +0000
@@ -1,5 +1,4 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
 <chapter>
   <title>Tracker</title>
   <section>

=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-09 17:15:21 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-14 15:00:18 +0000
@@ -689,6 +689,70 @@
       using the dataElementIScheme and orgUnitIdScheme paramaters.</para>
   </section>
   <section>
+    <title>Sending individual data values</title>
+    <para>This example will show how to send individual data values to be saved in a request. This
+      can be achieved by interacting with the <emphasis role="italic">dataValues</emphasis>
+      resource:</para>
+    <screen>http://apps.dhis2.org/demo/api/dataValues</screen>
+    <para>The following query parameters are supported for this resource:</para>
+    <table frame="all">
+      <title>Data values query parameters</title>
+      <tgroup cols="3">
+        <colspec colname="c1" colnum="1" colwidth="1*"/>
+        <colspec colname="c2" colnum="2" colwidth="1.59*"/>
+        <colspec colname="c3" colnum="3" colwidth="3.16*"/>
+        <thead>
+          <row>
+            <entry>Query parameter</entry>
+            <entry>Required</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>de</entry>
+            <entry>Yes</entry>
+            <entry>Data element identifier</entry>
+          </row>
+          <row>
+            <entry>co</entry>
+            <entry>No</entry>
+            <entry>Category option combo identifier, default will be used if omitted</entry>
+          </row>
+          <row>
+            <entry>pe</entry>
+            <entry>Yes</entry>
+            <entry>Period identifier</entry>
+          </row>
+          <row>
+            <entry>ou</entry>
+            <entry>Yes</entry>
+            <entry>Organisation unit identifier</entry>
+          </row>
+          <row>
+            <entry>value</entry>
+            <entry>No</entry>
+            <entry>Data value</entry>
+          </row>
+          <row>
+            <entry>comment</entry>
+            <entry>No</entry>
+            <entry>Data comment</entry>
+          </row>
+          <row>
+            <entry>followUp</entry>
+            <entry>No</entry>
+            <entry>Follow up on data value, will toggle the current boolean value</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+    <para>If any of the identifiers given are invalid, if the data value or comment are invalid or
+      if the data is locked, the response will contain the <emphasis role="italic">409
+        Conflict</emphasis> status code and descriptive text message. If the operation lead to a
+      saved or updated value, <emphasis role="italic">200 OK</emphasis> will be returned.</para>
+  </section>
+  <section>
     <title>Reading data values</title>
     <para>This section explains how to retrieve data values from the Web API by interacting with the dataValueSets resource. Data values can currently be retrieved in XML format. Since we want to read data we will use the <emphasis role="italic">GET</emphasis> HTTP verb. We will also specify that we are interested in the XML resource representation by including an <emphasis role="italic">Accept</emphasis> HTTP header with our request. The following query parameters are required:</para>
     <table>