dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 723
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2013-04-09 00:35:28 +0200
message:
  Update on api browsing
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-07 21:25:35 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-04-08 22:35:28 +0000
@@ -180,6 +180,17 @@
         </tgroup>
       </table>
     </para>
+    <para>An example of how these parameters can be used to get a full list of data element groups
+      in XML response format is:</para>
+    <screen>/api/dataElementGroups.xml?viewClass=detailed&amp;links=false&amp;paging=false</screen>
+    <para>You can query for elements on the name property instead of returning full list of elements
+      using the <emphasis role="italic">query</emphasis> path variable. In this example we query for
+      all data elements with the word "anaemia" in the name:</para>
+    <screen>/api/dataElements/query/anaemia</screen>
+    <para>You can search for elements through the id, name and code property using the <emphasis
+        role="italic">search</emphasis> path variable. In this example we search for a data element
+      with the word "DE_34" as id, name or
+      code:<screen>/api/dataElements/search/DE_34</screen></para>
   </section>
   <section>
     <title>Working with the meta-data API</title>