=== 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 @@
program
identifier
- true (unless programStage is provided)
- Identifier of wanted program.
+ false
+ Identifier of wanted program
programStage
identifier
- true (unless program is provided)
- Identifier of wanted program stage.
+ false
+ Identifier of wanted program stage
orgUnit
identifier
true
- Identifier of wanted organisation unit.
+ Identifier of wanted organisation unit
person
identifier
false
- Identifier of wanted person.
+ Identifier of wanted person
startDate
date
false
- Only events newer than this date.
+ Only events newer than this date
endDate
date
false
- Only events older than this date.
+ Only events older than this date
+
+
+ includeChildren
+ boolean
+ false
+ Include direct children of orgUnit
+
+
+ includeDescendants
+ boolean
+ false
+ Include all descendants of orgUnit
@@ -856,6 +868,10 @@
Examples
+ Query for all events with a certain orgUnit + children:
+ /api/events?orgUnit=ID&includeChildren=true
+ Query for all events with a certain orgUnit + descendants:
+ /api/events?orgUnit=ID&includeDescendants=true
Query for all events with a certain program/orgUnit:
/api/events?program=ID&orgUnit=ID
Query for all events with a certain program/orgUnit for a specific person: