dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1085
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2014-05-28 10:29:53 +0200
message:
  minor updates to browsing the web-api
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-05-27 20:43:30 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-05-28 08:29:53 +0000
@@ -133,13 +133,14 @@
   </section>
   <section>
     <title>Browsing the Web API</title>
-    <para>The entry point for browsing the Web API is <emphasis role="italic">/api/resources</emphasis>. This resource provide links to all available resources. Four
-      resource representation formats are consistently available for all resources: HTML, XML, JSON
-      and JSONP. Some resources will have other formats available, like MS Excel, PDF, CSV and PNG.
-      To explore the API from a web browser, navigate to the <emphasis role="italic">/api/resources</emphasis> entry point and follow the links to your desired resource, for
-      instance <emphasis role="italic">/api/resources/dataElements</emphasis>. For all resources
-      which return a list of elements certain query parameters can be used to modify the
-      response:</para>
+    <para>The entry point for browsing the Web API is <emphasis role="italic">/api/</emphasis>. This
+      resource provide links to all available resources. Four resource representation formats are
+      consistently available for all resources: HTML, XML, JSON and JSONP. Some resources will have
+      other formats available, like MS Excel, PDF, CSV and PNG. To explore the API from a web
+      browser, navigate to the <emphasis role="italic">/api/</emphasis> entry point and follow the
+      links to your desired resource, for instance <emphasis role="italic"
+        >/api/dataElements</emphasis>. For all resources which return a list of elements certain
+      query parameters can be used to modify the response:</para>
     <para>
       <table frame="all">
         <title>Query parameters</title>
@@ -160,7 +161,7 @@
             <row>
               <entry>viewClass</entry>
               <entry>basic | export | detailed </entry>
-              <entry>basic</entry>
+              <entry>basic for lists, detailed for objects</entry>
               <entry>Defines how much information to display for each element.</entry>
             </row>
             <row>