dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 826
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2013-10-04 14:37:21 +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-10-03 13:12:22 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-10-04 12:37:21 +0000
@@ -1883,8 +1883,8 @@
               <row>
                 <entry>hierarchyMeta</entry>
                 <entry>No</entry>
-                <entry>Include names of organisation unit ancestors in the hierarchy in
-                  meta-data</entry>
+                <entry>Include names of organisation unit ancestors and hierarchy paths of
+                  organisation units in the meta-data</entry>
                 <entry>false | true</entry>
               </row>
               <row>
@@ -2019,6 +2019,9 @@
             "2012Q1",
             "2012Q2"
         ],
+        "ou": [
+            "ImspTQPwCqd"
+        ],
         "names": {
             "2012Q1": "Jan to Mar 2012",
             "2012Q2": "Apr to Jun 2012",
@@ -2060,11 +2063,12 @@
       <para>The <emphasis role="italic">height</emphasis> and <emphasis role="italic">width</emphasis> properties indicate how many data columns and rows are contained in the
         response, respectively.</para>
       <para>The <emphasis role="italic">metaData periods</emphasis> property contains a unique,
-        ordered list of the periods included in the response. The <emphasis role="italic">metaData
-          names</emphasis> property contains a mapping between the identifiers used in the data
-        response and the names of the objects they represent. It can be used by clients to
-        substitute the identifiers within the data response with names in order to give a more
-        meaningful view of the data table.</para>
+        ordered array of the periods included in the response. The <emphasis role="italic">metaData
+          ou</emphasis> property contains an array of the identifiers of organisation units included
+        in the response. The <emphasis role="italic">metaData names</emphasis> property contains a
+        mapping between the identifiers used in the data response and the names of the objects they
+        represent. It can be used by clients to substitute the identifiers within the data response
+        with names in order to give a more meaningful view of the data table.</para>
       <para>The <emphasis role="italic">rows</emphasis> array contains the dimensional data table.
         It contains columns with dimension items (object or period identifiers) and a column with
         aggregated data values. The example response above has a data/indicator column, a period
@@ -2227,8 +2231,8 @@
             <row>
               <entry>hierarchyMeta</entry>
               <entry>No</entry>
-              <entry>Include names of organisation unit ancestors in the hierarchy in
-                meta-data</entry>
+              <entry>Include names of organisation unit ancestors and hierarchy paths of
+                organisation units in the meta-data</entry>
               <entry>false | true</entry>
             </row>
         </tbody>
@@ -2491,10 +2495,7 @@
         "hidden": false,
         "meta": false
     } ],
-    "metaData": {
-        "ou": {
-            "YuQRtpLP10I": "/ImspTQPwCqd/O6uvpzGd5pu"
-        },
+    "metaData": {        
         "names": {
             "qrur9Dvnyt5": "Age",
             "eBAyeGv0exc": "Inpatient morbidity and mortality",
@@ -2502,7 +2503,10 @@
             "O6uvpzGd5pu": "Bo",
             "YuQRtpLP10I": "Badjia",
             "oZg33kd9taw": "Gender"
-        }
+        },
+        "ouHierarchy": {
+            "YuQRtpLP10I": "/ImspTQPwCqd/O6uvpzGd5pu"
+        },
     },
     "width": 8,
     "height": 25,