=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2014-04-03 12:44:05 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-04-04 17:24:50 +0000
@@ -4178,6 +4178,13 @@
Status of the instance for the given program. Can be ACTIVE | COMPLETED |
CANCELLED.
+
+ programDate
+ Date of enrollment into the given program for the tracked entity instance.
+ Param can be repeated any number of times. Specified on the format
+ <operator>:<date>. See section on date format. Operators can be EQ | GT | GE |
+ LT | LE | NE.
+
trackedEntity
Tracked entity identifer. Restricts instances to the given tracked instance
@@ -4241,6 +4248,8 @@
To constrain the response to instances which are part of a specific program you can
include a program query parameter like this:
api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&program=ur1Edk5Oe2n
+ To specify program enrollment dates as part of the query you can use this syntax:
+ api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&program=ur1Edk5Oe2n&programDate=GT:2013-01-01&programDate=LT:2013-09-01
To constrain the response to instances of a specific tracked entity you can include a
tracked entity query parameter like this:
api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&trackedEntity=cyl5vuJ5ETQ