dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #22683
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 740: Docs for analytics ou level/boundary selection
------------------------------------------------------------
revno: 740
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2013-05-24 13:54:48 +0200
message:
Docs for analytics ou level/boundary selection
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-23 17:10:40 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-05-24 11:54:48 +0000
@@ -1217,8 +1217,8 @@
<row>
<entry>Organisation unit hierarchy</entry>
<entry>ou</entry>
- <entry>Organisation unit identifiers and USER_ORGUNIT |
- USER_ORGUNIT_CHILDREN</entry>
+ <entry>Organisation unit identifiers, USER_ORGUNIT | USER_ORGUNIT_CHILDREN and
+ LEVEL-<level>-<boundary-id></entry>
</row>
<row>
<entry>Category option combinations</entry>
@@ -1287,10 +1287,17 @@
the period format and available relative periods.</para>
</listitem>
<listitem>
- <para>The organisation unit dimension you can specify the items to be the organisation unit
- or hierarchy children of the organisation unit associated with the user authenticated for
- the request using they keys USER_ORGUNIT or USER_ORGUNIT_CHILDREN as items, respectively.
- You can also specify organisation unit identifiers, or a combination of both.</para>
+ <para>For the organisation unit dimension you can specify the items to be the organisation
+ unit or sub-units of the organisation unit associated with the user currently
+ authenticated for the request using they keys USER_ORGUNIT or USER_ORGUNIT_CHILDREN as
+ items, respectively. You can also specify organisation unit identifiers directly, or a
+ combination of both.</para>
+ </listitem>
+ <listitem>
+ <para>For the organisation unit dimension you can specify the organisation hierarchy level
+ and the boundary unit to use for the request on the format
+ LEVEL-<level>-<boundary-id>; as an example LEVEL-3-ImspTQPwCqd implies all
+ organisation units below the given boundary unit at level 3 in the hierarchy.</para>
</listitem>
<listitem>
<para>For the organisation unit dimension the dimension items are the organisation units and