dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 949
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Thu 2014-01-23 11:45:45 +0200
message:
  Complete data set registrations api docs
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	2014-01-13 19:01:57 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-01-23 09:45:45 +0000
@@ -1007,8 +1007,8 @@
   </section>
   </section>
   <section>
-    <title>Reading dataset complete registrations</title>
-    <para>This section explains how to retrieve dataset completeness registrations. We will be using
+    <title>Reading complete data set registrations</title>
+    <para>This section explains how to retrieve data set completeness registrations. We will be using
       the completeDataSetRegistrations resource. The query parameters to use are these:</para>
     <table frame="all">
       <title>Data value set query parameters</title>
@@ -1061,6 +1061,63 @@
         role="italic">application/json</emphasis>.</para>
   </section>
   <section>
+    <title>Completing and un-completing data sets</title>
+    <para>This section explains how you can register and un-register a data set as complete. To
+      complete or un-complete a data set you will interact with the following resource:</para>
+    <screen>/api/completeDataSetRegistrations</screen>
+    <para>This resource supports the methods <emphasis role="italic">POST</emphasis> for
+      registration and <emphasis role="italic">DELETE</emphasis> for un-registration. The following
+      query parameters are supported:</para>
+    <table frame="all">
+      <title>Complete data set registrations query parameters</title>
+      <tgroup cols="3">
+        <colspec colname="c1" colnum="1" colwidth="1*"/>
+        <colspec colname="c2" colnum="2" colwidth="1.16*"/>
+        <colspec colname="c3" colnum="3" colwidth="3.96*"/>
+        <thead>
+          <row>
+            <entry>Query parameter</entry>
+            <entry>Required</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>ds</entry>
+            <entry>Yes</entry>
+            <entry>Data set 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>cc</entry>
+            <entry>No (must combine with cp)</entry>
+            <entry>Attribute combo identifier (for locking check)</entry>
+          </row>
+          <row>
+            <entry>cp</entry>
+            <entry>No (must combine with cp)</entry>
+            <entry>Attribute option identifiers, separated with ; for multiple values (for locking
+              check)</entry>
+          </row>
+          <row>
+            <entry>multiOu</entry>
+            <entry>No (default false)</entry>
+            <entry>Whether registration applies to sub units</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+  </section>
+  <section>
     <title>Data approval</title>
     <para>This section explains how to approve, unapprove and check approval status using the
         <emphasis role="italic">dataApprovals</emphasis> resource. Approval is done per data set,