=== 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 @@
Organisation unit hierarchy
ou
Organisation unit identifiers, USER_ORGUNIT | USER_ORGUNIT_CHILDREN and
- LEVEL-<level>-<boundary-id>
+ LEVEL-<level>-<boundary-id> and OU_GROUP-<group-id>
Category option combinations
@@ -1509,6 +1509,15 @@
To query using relative periods and organisation units associated with the current user
you can use a URL like this:
api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&dimension=pe:LAST_12_MONTHS&dimension=ou:USER_ORGUNIT
+ When selecting organisation units for a dimension you can select an entire level below a
+ boundary organisation unit with the LEVEL-<level>-<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:
+ api/analytics?dimension=dx:fbfJHSPpUQD&dimension=pe:2012&dimension=ou:LEVEL-3-O6uvpzGd5pu
+ 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-<uid> syntax.
+ Both the level and the group items can be repeated any number of times:
+ api/analytics?dimension=dx:fbfJHSPpUQD&dimension=pe:2012&dimension=ou:OU_GROUP-w0gFTTmsUcF
A few things to be aware of when using the analytics resource are listed below.