dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 884
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2013-12-20 00:16:12 +0100
message:
  Data values
modified:
  src/docbkx/en/dhis2_user_man_web_api.xml
  src/docbkx/en/dhis2_user_manual_en.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-12-18 09:40:58 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-19 23:16:12 +0000
@@ -699,8 +699,8 @@
       <title>Data values query parameters</title>
       <tgroup cols="3">
         <colspec colname="c1" colnum="1" colwidth="1*"/>
-        <colspec colname="c2" colnum="2" colwidth="1.59*"/>
-        <colspec colname="c3" colnum="3" colwidth="3.16*"/>
+        <colspec colname="c2" colnum="2" colwidth="1.23*"/>
+        <colspec colname="c3" colnum="3" colwidth="4.08*"/>
         <thead>
           <row>
             <entry>Query parameter</entry>
@@ -715,19 +715,29 @@
             <entry>Data element identifier</entry>
           </row>
           <row>
+            <entry>pe</entry>
+            <entry>Yes</entry>
+            <entry>Period identifier</entry>
+          </row>
+          <row>
+            <entry>ou</entry>
+            <entry>Yes</entry>
+            <entry>Organisation unit identifier</entry>
+          </row>
+          <row>
             <entry>co</entry>
             <entry>No</entry>
             <entry>Category option combo identifier, default will be used if omitted</entry>
           </row>
           <row>
-            <entry>pe</entry>
-            <entry>Yes</entry>
-            <entry>Period identifier</entry>
+            <entry>cc</entry>
+            <entry>No (must combine with cp)</entry>
+            <entry>Attribute combo identifier</entry>
           </row>
           <row>
-            <entry>ou</entry>
-            <entry>Yes</entry>
-            <entry>Organisation unit identifier</entry>
+            <entry>cp</entry>
+            <entry>No (must combine with cc)</entry>
+            <entry>Attribute option identifiers, can be repeated multiple times</entry>
           </row>
           <row>
             <entry>value</entry>
@@ -752,7 +762,12 @@
         Conflict</emphasis> status code and descriptive text message. If the operation lead to a
       saved or updated value, <emphasis role="italic">200 OK</emphasis> will be returned. An example
       of a request looks like this:</para>
-    <screen>curl "http://apps.dhis2.org/demo/api/dataValues?de=s46m5MS0hxu&amp;co=Prlt0C1RF0s&amp;pe=201301&amp;ou=DiszpKrYNg8&amp;value=12"; -X POST -u admin:district -v</screen>
+    <screen>curl "http://apps.dhis2.org/demo/api/dataValues?de=s46m5MS0hxu&amp;pe=201301&amp;ou=DiszpKrYNg8&amp;co=Prlt0C1RF0s&amp;value=12"; -X POST -u admin:district -v</screen>
+    <para>This resource also allows a special syntax for associating the value to an attribute
+      option combination. This can be done by sending the identifier of the attribute combination,
+      together with the identifier(s) of the attribute option(s) which the value represents within
+      the combination. An example looks like this:</para>
+    <screen>curl "http://apps.dhis2.org/demo/api/dataValues?de=s46m5MS0hxu&amp;ou=DiszpKrYNg8&amp;pe=201308&amp;cc=dzjKKQq0cSO&amp;cp=wbrDrL2aYEc&amp;cp=btOyqprQ9e8&amp;value=26"; -X POST -u admin:district -v</screen>
   </section>
   <section>
     <title>Reading data values</title>

=== modified file 'src/docbkx/en/dhis2_user_manual_en.xml'
--- src/docbkx/en/dhis2_user_manual_en.xml	2013-10-02 14:52:27 +0000
+++ src/docbkx/en/dhis2_user_manual_en.xml	2013-12-19 23:16:12 +0000
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; [
 <!ENTITY version '2.X'>
 <!ENTITY title 'DHIS2 User Manual'>
  ]>
@@ -33,9 +33,7 @@
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_persons_and_programs.xml" encoding="UTF-8"/>
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_web_api.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_apps.xml"/>
-<!--
-  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_excel_reports.xml" encoding="UTF-8"/>
-  -->  <appendix>
+  <appendix>
     <title> DHIS 2 Documentation Guide</title>
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_documentation_guide.xml" encoding="UTF-8" xpointer="docs_1"/>
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_documentation_guide.xml" encoding="UTF-8" xpointer="docs_2"/>