dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 736
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Mon 2013-05-20 16:49:21 +0200
message:
  Section on bulk export in web api
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-05-20 06:12:56 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-05-20 14:49:21 +0000
@@ -478,7 +478,9 @@
       </tgroup>
     </table>
     <para>It is assumed that we have posted data values to DHIS according to the previous section called &quot;Sending data values&quot;. We can now put together our request and send it using cURL:</para>
-    <para><code>curl &quot;http://apps.dhis2.org/demo/api/dataValueSets?dataSet=pBOMPrpg1QX</code><code>&amp;period=201201&amp;orgUnit=DiszpKrYNg8&quot; -H &quot;Accept:application/xml&quot; -u admin:district -v </code></para>
+    <para><code>curl
+        &quot;http://apps.dhis2.org/demo/api/dataValueSets?dataSet=pBOMPrpg1QX</code><code>&amp;period=201201&amp;orgUnit=DiszpKrYNg8&quot;
+        -H &quot;Accept:application/xml&quot; -u admin:district -v</code></para>
     <para>The  response will look something like this:</para>
     <screen>HTTP/1.1 200 OK
 Content-Type: application/xml
@@ -496,6 +498,53 @@
     <para>The header tells us that the request was processed successfully and that we are receiving a response in XML format. The XML message looks familiar - it is the data values we sent in the previous section.</para>
   </section>
   <section>
+    <title>Reading large bulks of data values</title>
+    <para>This section explains how to retrieve large bulks of data values which not necessarily
+      belong in a single data value set. We will, like in the previous section, interact with the
+      dataValueSets resource. The query parameters to use are these:</para>
+    <table frame="all">
+      <title>Data value set query parameters</title>
+      <tgroup cols="2">
+        <colspec colname="c1" colnum="1" colwidth="195pt"/>
+        <colspec colname="c2" colnum="2" colwidth="605.25pt"/>
+        <thead>
+          <row>
+            <entry><emphasis role="italic">Parameter</emphasis></entry>
+            <entry><emphasis role="italic">Description</emphasis></entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>dataSet</entry>
+            <entry>Data set identifier, can be specified multiple times</entry>
+          </row>
+          <row>
+            <entry>startDate</entry>
+            <entry>Start date for the time span of the values to export</entry>
+          </row>
+          <row>
+            <entry>endDate</entry>
+            <entry>End date for the time span of the values to export</entry>
+          </row>
+          <row>
+            <entry>orgUnit</entry>
+            <entry>Organisation unit identifier, can be specified multiple times</entry>
+          </row>
+          <row>
+            <entry>children</entry>
+            <entry>Whether to include the children in the hierarchy of the organisation
+              units</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+    <para>The dataSet and orgUnit parameters can be repeated in order to include multiple data sets
+      and organisation units. An example request looks like this:</para>
+    <para><code>curl
+        "http://apps.dhis2.org/demo/api/dataValueSets?dataSet=pBOMPrpg1QX&amp;dataSet=BfMAe6Itzgt&amp;startDate=2013-01-01&amp;endDate=2013-01-31&amp;orgUnit=YuQRtpLP10I&amp;orgUnit=vWbkYPRmKyS&amp;children=true";
+        -H "Accept:application/xml" -u admin:district -v</code></para>
+  </section>
+  <section>
     <title>Writing and reading messages</title>
     <para>DHIS 2 features a mechanism for sending messages for purposes such as user feedback, notifications and general information to  users. Messages are delivered to the DHIS 2 message inbox but can also be sent to the user&apos;s email addresses and mobile phones as SMS. In this example we will see how we can utilize the Web API to send and read messages. We will pretend to be the <emphasis role="italic">DHIS Administrator</emphasis>   user  and  send a message to the  <emphasis role="italic">Mobile</emphasis> user. We will then pretend to be the  mobile user and read our new message.</para>
     <para>The resource we need to interact with when sending and reading messages is the <emphasis role="italic">messageConversations</emphasis> resource. We start by visiting the Web API entry point at <ulink url="http://apps.dhis2.org/demo/api"/> where we find and follow the link to the <emphasis role="italic">messageConversations</emphasis> resource at <ulink url="http://apps.dhis2.org/demo/api/messageConversations"/>. The description tells us that we can use a POST request to create a new message using the following XML format:</para>