dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 778
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2013-08-09 16:23:23 +0200
message:
  Docs for ou group and level ou selection in analytics
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-08-08 10:46:46 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-08-09 14:23:23 +0000
@@ -1455,7 +1455,7 @@
                 <entry>Organisation unit hierarchy</entry>
                 <entry>ou</entry>
                 <entry>Organisation unit identifiers, USER_ORGUNIT | USER_ORGUNIT_CHILDREN and
-                  LEVEL-&lt;level>-&lt;boundary-id></entry>
+                  LEVEL-&lt;level>-&lt;boundary-id> and OU_GROUP-&lt;group-id></entry>
               </row>
               <row>
                 <entry>Category option combinations</entry>
@@ -1509,6 +1509,15 @@
     <para>To query using relative periods and organisation units associated with the current user
       you can use a URL like this:</para>
     <screen>api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&amp;dimension=pe:LAST_12_MONTHS&amp;dimension=ou:USER_ORGUNIT</screen>
+    <para>When selecting organisation units for a dimension you can select an entire level below a
+      boundary organisation unit with the LEVEL-&lt;level>-&lt;boundary-id> syntax. Boundary refers
+      to a top node in a sub-hierarchy, meaning that all organisation units at the given level below
+      the given boundary organisation unit in the hierarchy will be included in the response:</para>
+    <screen>api/analytics?dimension=dx:fbfJHSPpUQD&amp;dimension=pe:2012&amp;dimension=ou:LEVEL-3-O6uvpzGd5pu</screen>
+    <para>When selecting organisation units you can also select all organisation units in an
+      organisation unit group to be included as dimension items using the OU_GROUP-&lt;uid> syntax.
+      Both the level and the group items can be repeated any number of times:</para>
+    <screen>api/analytics?dimension=dx:fbfJHSPpUQD&amp;dimension=pe:2012&amp;dimension=ou:OU_GROUP-w0gFTTmsUcF</screen>
     <para>A few things to be aware of when using the analytics resource are listed below.</para>
     <itemizedlist>
       <listitem>