← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-devs-core/dhis2/trunk] Rev 5971: Corrected web api doc text

 

------------------------------------------------------------
revno: 5971
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Wed 2012-02-15 19:21:05 +0100
message:
  Corrected web api doc text
modified:
  dhis-2/dhis-web/dhis-web-api/src/main/resources/templates/html/dataValueSets.xsl


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription
=== modified file 'dhis-2/dhis-web/dhis-web-api/src/main/resources/templates/html/dataValueSets.xsl'
--- dhis-2/dhis-web/dhis-web-api/src/main/resources/templates/html/dataValueSets.xsl	2012-01-11 09:02:20 +0000
+++ dhis-2/dhis-web/dhis-web-api/src/main/resources/templates/html/dataValueSets.xsl	2012-02-15 18:21:05 +0000
@@ -11,36 +11,16 @@
     <![CDATA[
 The DataValueSet resource gives you a mean to POST dataValues into DHIS 2.
 
-an optional phoneNumber query parameter can be provided and will override the organisation unit identifier of the
+An optional phoneNumber query parameter can be provided and will override the organisation unit identifier of the
 data value set, this will be matched against the phoneNumber for the users in the system, and the dataValues will
 be added to their orgUnit.
 
-The supported format is XML, and the root dataValueSet is declared with the following attributes
-
-dataSet     - The UID of the dataset to report on
-period      - The period to report on
-orgUnit     - The UID of organisation unit to report on
-
-The actual dataValues are sent with a format matching this:
-
-<dataValues>
-    <dataValue dataElement="dataElementUid" value="1" />
-    <dataValue dataElement="dataElementUid" value="2" />
-    <dataValue dataElement="dataElementUid" value="3" />
-    <dataValue dataElement="dataElementUid" value="4" />
-    <dataValue dataElement="dataElementUid" value="5" />
-</dataValues>
-
-So, a complete example would be:
-
-<dataValueSet dataSet="dataSetUid" period="2012-01-01" orgUnit="orgUnitUid">
-    <dataValues>
-        <dataValue dataElement="dataElementUid" value="1" />
-        <dataValue dataElement="dataElementUid" value="2" />
-        <dataValue dataElement="dataElementUid" value="3" />
-        <dataValue dataElement="dataElementUid" value="4" />
-        <dataValue dataElement="dataElementUid" value="5" />
-    </dataValues>
+Period values are given in ISO format. A complete example of a data value set would be:
+
+<dataValueSet xmlns="http://dhis2.org/schema/dxf/2.0"; period="periodISODate" dataSet="dataSetID" orgUnit="orgUnitID">
+  <dataValue dataElement="dataElementId" categoryOptionCombo="categoryOptionComboId" value="1" />
+  <dataValue dataElement="dataElementId" categoryOptionCombo="categoryOptionComboId" value="2" />
+  <dataValue dataElement="dataElementId" categoryOptionCombo="categoryOptionComboId" value="3" />
 </dataValueSet>
     ]]>
     </pre>