dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1028
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2014-04-18 16:01:10 +0200
message:
  TEI query
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-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.</entry>
           </row>
             <row>
+              <entry>eventStatus</entry>
+              <entry>Status of any event associated with the given program and the tracked entity
+                instance. Can be COMPLETED | VISITED | FUTURE_VISIT | LATE_VISIT | SKIPPED.</entry>
+            </row>
+            <row>
+              <entry>eventStartDate</entry>
+              <entry>Start date of event associated with the given program and event status.</entry>
+            </row>
+            <row>
+              <entry>eventEndDate</entry>
+              <entry>End date of event associated with the given program and event status.</entry>
+            </row>
+            <row>
               <entry>skipMeta</entry>
               <entry>Indicates whether meta data for the response should be included.</entry>
             </row>
@@ -4354,6 +4367,20 @@
               role="italic">program</emphasis> must also be specified.</para>
         </listitem>
         <listitem>
+          <para>If <emphasis role="italic">followUp</emphasis> is specified then <emphasis
+              role="italic">program</emphasis> must also be specified.</para>
+        </listitem>
+        <listitem>
+          <para>If <emphasis role="italic">programStartDate</emphasis> or <emphasis role="italic"
+              >programEndDate</emphasis> is specified then <emphasis role="italic"
+              >program</emphasis> must also be specified.</para>
+        </listitem>
+        <listitem>
+          <para>If <emphasis role="italic">eventStatus</emphasis> is specified then <emphasis
+              role="italic">eventStartDate</emphasis> and <emphasis role="italic"
+              >eventEndDate</emphasis> must also be specified.</para>
+        </listitem>
+        <listitem>
           <para>A query cannot be specified together with filters.</para>
         </listitem>
         <listitem>
@@ -4395,6 +4422,9 @@
     <para>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:</para>
     <screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&amp;ou=O6uvpzGd5pu&amp;ouMode=DESCENDANTS&amp;page=2&amp;pageSize=3</screen>
+      <para>To query for instances which have events of a given status within a given time span you
+        can use this syntax:</para>
+      <screen>api/trackedEntityInstances.json?ou=O6uvpzGd5pu&amp;program=ur1Edk5Oe2n&amp;eventStatus=LATE_VISIT&amp;eventStartDate=2014-01-01&amp;eventEndDate=2014-09-01</screen>
     <para>You can use a range of operators for the filtering:</para>
     <table frame="all">
       <title>Filter operators</title>