← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1001: document schema resource

 

------------------------------------------------------------
revno: 1001
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2014-04-02 20:42:21 +0700
message:
  document schema resource
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-04-01 11:13:06 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-04-02 13:42:21 +0000
@@ -4269,6 +4269,15 @@
     </section>
   </section>
   <section>
+    <title>Schema Resource</title>
+    <para>A new resource was included in DHIS 2.15 which can be used to introspect all available DXF2 classes, this resource can be found on
+        <emphasis role="italic">/api/schemas</emphasis> and for a specific resource, you can have a look at <emphasis role="italic"
+        >/api/schemas/TYPE</emphasis>.</para>
+    <para>Example 1: Get all available schemas in XML:<screen>GET /api/schemas.xml</screen></para>
+    <para>Example 2: Get all available schemas in JSON:<screen>GET /api/schemas.json</screen></para>
+    <para>Example 3: Get JSON schema for a specific class:<screen>GET /api/schemas/dataElement.json</screen></para>
+  </section>
+  <section>
     <title>FRED API</title>
     <para>DHIS 2 from version 2.11 implements support for the current draft
       of the FRED API version 1.0. The project defines itself as <quote>open standard for sharing and updating