dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1007
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2014-04-04 19:24:50 +0200
message:
  Docs
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	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 @@
               <entry>Status of the instance for the given program. Can be ACTIVE | COMPLETED |
                 CANCELLED.</entry>
             </row>
+            <row>
+              <entry>programDate</entry>
+              <entry>Date of enrollment into the given program for the tracked entity instance.
+                Param can be repeated any number of times. Specified on the format
+                &lt;operator>:&lt;date>. See section on date format. Operators can be EQ | GT | GE |
+                LT | LE | NE.</entry>
+            </row>
           <row>
             <entry>trackedEntity</entry>
             <entry>Tracked entity identifer. Restricts instances to the given tracked instance
@@ -4241,6 +4248,8 @@
     <para>To constrain the response to instances which are part of a specific program you can
       include a program query parameter like this:</para>
     <screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&amp;ou=O6uvpzGd5pu&amp;ouMode=DESCENDANTS&amp;program=ur1Edk5Oe2n</screen>
+      <para>To specify program enrollment dates as part of the query you can use this syntax:</para>
+      <screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&amp;ou=O6uvpzGd5pu&amp;program=ur1Edk5Oe2n&amp;programDate=GT:2013-01-01&amp;programDate=LT:2013-09-01</screen>
     <para>To constrain the response to instances of a specific tracked entity you can include a
       tracked entity query parameter like this:</para>
     <screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&amp;ou=O6uvpzGd5pu&amp;ouMode=DESCENDANTS&amp;trackedEntity=cyl5vuJ5ETQ</screen>