dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 730
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2013-04-23 14:01:27 +0200
message:
  Analytics update
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-04-08 22:35:28 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-04-23 12:01:27 +0000
@@ -1156,9 +1156,10 @@
                   USER_ORGUNIT_CHILDREN</entry>
               </row>
               <row>
-                <entry>Categories</entry>
+                <entry>Category option combinations</entry>
                 <entry>co</entry>
-                <entry>Not possible to define dimension items for categories</entry>
+                <entry>Not possible to define dimension items - all relevant items are
+                  returned</entry>
               </row>
               <row>
                 <entry>Data element group sets</entry>
@@ -1170,6 +1171,11 @@
                 <entry>&lt;group set id></entry>
                 <entry>Organisation unit group identifiers (omit to get all items)</entry>
               </row>
+              <row>
+                <entry>Categories</entry>
+                <entry>&lt;category id></entry>
+                <entry>Category option identifiers (omit to get all items)</entry>
+              </row>
             </tbody>
           </tgroup>
         </table>
@@ -1184,14 +1190,18 @@
       items are separated by semi-colons. As an example, a query for two data elements, two periods
       and two organisation units can be done with the following URL:</para>
     <screen>api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&amp;dimension=pe:2012Q1;2012Q2&amp;dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw</screen>
-    <para>To query for data broken down by categories instead of data element totals you can include
-      the category dimension in the query string, for instance like this:</para>
+    <para>To query for data broken down by category option combinations instead of data element
+      totals you can include the category dimension in the query string, for instance like
+      this:</para>
     <screen>api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&amp;dimension=co&amp;dimension=pe:201201&amp;dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw</screen>
     <para>To query for organisation unit group sets and data elements you can use the following URL
       - notice how the group set identifier is used as dimension identifier and the groups as
       dimension items:</para>
     <screen>api/analytics?dimension=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&amp;dimension=pe:2012&amp;dimension=ou:ImspTQPwCqd</screen>
-    <para>To query using relative periods and organiastion units associated with the current user
+    <para>To query for data elements and categories you can use this URL - use the category
+      identifier as dimension identifier and the category options as dimension items:</para>
+    <screen>api/analytics?dimension=dx:s46m5MS0hxu;fClA2Erf6IO&amp;dimension=pe:2012&amp;dimension=YNZyaJHiHYq:btOyqprQ9e8;GEqzEKCHoGA&amp;filter=ou:ImspTQPwCqd</screen>
+    <para>To query using relative periods and organisation units associated with the current user
       you can use a URL like this:</para>
     <screen>api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&amp;dimension=pe:LAST_12_MONTHS&amp;dimension=ou:USER_ORGUNIT</screen>
     <para>A few things to be aware of when using the analytics resource are listed below.</para>
@@ -1223,8 +1233,8 @@
           organisation unit in the hierarchy.</para>
       </listitem>
       <listitem>
-        <para>You cannot specify dimension items for the category dimension. Instead the response
-          will contain the categories which are linked to the data values.</para>
+        <para>You cannot specify dimension items for the category option combination dimension.
+          Instead the response will contain the items which are linked to the data values.</para>
       </listitem>
     </itemizedlist>
     <section>
@@ -1450,6 +1460,10 @@
           <para>Data element group sets cannot be specified together with data sets.</para>
         </listitem>
         <listitem>
+          <para>Categories can only be specified together with data elements, not indicators or data
+            sets.</para>
+        </listitem>
+        <listitem>
           <para>A dimension cannot be specified more than once.</para>
         </listitem>
         <listitem>