dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 663
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2013-03-06 15:09:56 +0100
message:
  Analytics, a bit on error handling
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-03-06 13:06:55 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-03-06 14:09:56 +0000
@@ -1290,22 +1290,22 @@
         representation formats. As usual, you can indicate interest in a specific format by
         appending a file extension to the URL, through the <emphasis role="italic">Accept</emphasis>
         HTTP header or through the <emphasis role="italic">format</emphasis> query parameter. The
-        default format is JSON. The available formats are listed below.</para>
+        default format is JSON. The available formats and content-types are listed below.</para>
       <itemizedlist>
         <listitem>
-          <para>json</para>
-        </listitem>
-        <listitem>
-          <para>xml</para>
-        </listitem>
-        <listitem>
-          <para>csv</para>
-        </listitem>
-        <listitem>
-          <para>html</para>
-        </listitem>
-        <listitem>
-          <para>xls (MS Excel)</para>
+          <para>json (application/json)</para>
+        </listitem>
+        <listitem>
+          <para>xml (application/xml)</para>
+        </listitem>
+        <listitem>
+          <para>csv (application/csv)</para>
+        </listitem>
+        <listitem>
+          <para>html (text/html)</para>
+        </listitem>
+        <listitem>
+          <para>xls (application/vnd.ms-excel)</para>
         </listitem>
       </itemizedlist>
       <para>As an example, to request an analytics response in XML format you can use the following
@@ -1427,6 +1427,9 @@
             reasons.</para>
         </listitem>
       </itemizedlist>
+      <para>When a query request violates any of these constraints the server will return a response
+        with status code 409 and content-type "text/plain" together with a textual description of
+        the problem.</para>
     </section>
     <section>
       <title>Generating the analytics tables</title>