dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 869
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Mon 2013-11-25 15:59:33 +0100
message:
  document includeChildren/includeDescendants, update required parameters
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-11-25 14:51:03 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-11-25 14:59:33 +0000
@@ -817,38 +817,50 @@
             <row>
               <entry>program</entry>
               <entry>identifier</entry>
-              <entry>true (unless programStage is provided)</entry>
-              <entry>Identifier of wanted program.</entry>
+              <entry>false</entry>
+              <entry>Identifier of wanted program</entry>
             </row>            
             <row>
               <entry>programStage</entry>
               <entry>identifier</entry>
-              <entry>true (unless program is provided)</entry>
-              <entry>Identifier of wanted program stage.</entry>
+              <entry>false</entry>
+              <entry>Identifier of wanted program stage</entry>
             </row>
             <row>
               <entry>orgUnit</entry>
               <entry>identifier</entry>
               <entry>true</entry>
-              <entry>Identifier of wanted organisation unit.</entry>
+              <entry>Identifier of wanted organisation unit</entry>
             </row>
             <row>
               <entry>person</entry>
               <entry>identifier</entry>
               <entry>false</entry>
-              <entry>Identifier of wanted person.</entry>
+              <entry>Identifier of wanted person</entry>
             </row>
             <row>
               <entry>startDate</entry>
               <entry>date</entry>
               <entry>false</entry>
-              <entry>Only events newer than this date.</entry>
+              <entry>Only events newer than this date</entry>
             </row>
             <row>
               <entry>endDate</entry>
               <entry>date</entry>
               <entry>false</entry>
-              <entry>Only events older than this date.</entry>
+              <entry>Only events older than this date</entry>
+            </row>
+            <row>
+              <entry>includeChildren</entry>
+              <entry>boolean</entry>
+              <entry>false</entry>
+              <entry>Include direct children of orgUnit</entry>
+            </row>
+            <row>
+              <entry>includeDescendants</entry>
+              <entry>boolean</entry>
+              <entry>false</entry>
+              <entry>Include all descendants of orgUnit</entry>
             </row>
           </tbody>
         </tgroup>
@@ -856,6 +868,10 @@
     </para>
     <section>
       <title>Examples</title>
+      <para>Query for all events with a certain orgUnit + children:
+        <screen>/api/events?orgUnit=ID&amp;includeChildren=true</screen></para>
+      <para>Query for all events with a certain orgUnit + descendants:
+        <screen>/api/events?orgUnit=ID&amp;includeDescendants=true</screen></para>
       <para>Query for all events with a certain program/orgUnit:
         <screen>/api/events?program=ID&amp;orgUnit=ID</screen></para>
       <para>Query for all events with a certain program/orgUnit for a specific person: