dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 820
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2013-10-02 16:40:39 +0200
message:
  Analytics
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	2013-09-29 21:25:05 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-10-02 14:40:39 +0000
@@ -2160,7 +2160,7 @@
     <title>Request query parameters</title>
     <para>The analytics event API let you specify a range of query parameters.</para>
     <table frame="all">
-	<title>Query parameters</title>
+	<title>Query parameters for both event query and aggregate analytics</title>
       <tgroup cols="4">
         <colspec colname="c1" colnum="1" colwidth="1.8*"/>
         <colspec colname="c2" colnum="2" colwidth="1*"/>
@@ -2217,6 +2217,25 @@
                 &lt;item-id>:&lt;operator>:&lt;filter>. Filter values are case-insensitive.</entry>
               <entry/>
             </row>
+        </tbody>
+      </tgroup>
+    </table>
+      <table frame="all">
+        <title>Query parameters for event query analytics only</title>
+        <tgroup cols="4">
+          <colspec colname="c1" colnum="1" colwidth="1.85*"/>
+          <colspec colname="c2" colnum="2" colwidth="1*"/>
+          <colspec colname="c3" colnum="3" colwidth="4.4*"/>
+          <colspec colname="c4" colnum="4" colwidth="1.72*"/>
+          <thead>
+            <row>
+              <entry><emphasis role="italic">Query parameter</emphasis></entry>
+              <entry><emphasis role="italic">Required</emphasis></entry>
+              <entry><emphasis role="italic">Description</emphasis></entry>
+              <entry><emphasis role="italic">Options</emphasis></entry>
+            </row>
+          </thead>
+          <tbody>
             <row>
               <entry>ouMode</entry>
               <entry>No</entry>
@@ -2252,9 +2271,40 @@
               <entry>The page size. Unlimited if not specified.</entry>
               <entry>Numeric zero or positive value</entry>
             </row>
-        </tbody>
-      </tgroup>
-    </table>
+          </tbody>
+        </tgroup>
+      </table>
+      <table frame="all">
+        <title>Query parameters for event query analytics</title>
+        <tgroup cols="4">
+          <colspec colname="c1" colnum="1" colwidth="1.89*"/>
+          <colspec colname="c2" colnum="2" colwidth="1*"/>
+          <colspec colname="c3" colnum="3" colwidth="4.46*"/>
+          <colspec colname="c4" colnum="4" colwidth="1.74*"/>
+          <thead>
+            <row>
+              <entry><emphasis role="italic">Query parameter</emphasis></entry>
+              <entry><emphasis role="italic">Required</emphasis></entry>
+              <entry><emphasis role="italic">Description</emphasis></entry>
+              <entry><emphasis role="italic">Options</emphasis></entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry>limit</entry>
+              <entry>No</entry>
+              <entry>The maximum number of records to return</entry>
+              <entry>Numeric positive value</entry>
+            </row>
+            <row>
+              <entry>sortOrder</entry>
+              <entry>No</entry>
+              <entry>Sort the records on the value column in ascending or descending order.</entry>
+              <entry>ASC | DESC</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </table>
     </section>
     <section>
 	<title>Event query analytics</title>