=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2014-04-18 09:53:00 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-04-18 14:01:10 +0000
@@ -4304,6 +4304,19 @@
type.
+ eventStatus
+ Status of any event associated with the given program and the tracked entity
+ instance. Can be COMPLETED | VISITED | FUTURE_VISIT | LATE_VISIT | SKIPPED.
+
+
+ eventStartDate
+ Start date of event associated with the given program and event status.
+
+
+ eventEndDate
+ End date of event associated with the given program and event status.
+
+
skipMeta
Indicates whether meta data for the response should be included.
@@ -4354,6 +4367,20 @@
role="italic">program must also be specified.
+ If followUp is specified then program must also be specified.
+
+
+ If programStartDate or programEndDate is specified then program must also be specified.
+
+
+ If eventStatus is specified then eventStartDate and eventEndDate must also be specified.
+
+
A query cannot be specified together with filters.
@@ -4395,6 +4422,9 @@
By default the instances are returned in pages of size 50, to change this you can use the
page and pageSize query parameters like this:
api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&page=2&pageSize=3
+ To query for instances which have events of a given status within a given time span you
+ can use this syntax:
+ api/trackedEntityInstances.json?ou=O6uvpzGd5pu&program=ur1Edk5Oe2n&eventStatus=LATE_VISIT&eventStartDate=2014-01-01&eventEndDate=2014-09-01
You can use a range of operators for the filtering: