=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml' --- src/docbkx/en/dhis2_user_man_web_api.xml 2012-10-10 06:58:47 +0000 +++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-02-04 17:41:18 +0000 @@ -111,6 +111,69 @@
+ Browsing the Web API + The entry point for browsing the Web API is /api/resources. This resource provide links to all available resources. Four + resouce 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 /api/resources entry point and follow the links to your desired resource, for + instance /api/resources/dataElements. For all resources + which return a list of elements certain query parameters can be used to modify the + response: + + + Query parameters + + + + + + + + Param + Option values + Default option + Description + + + + + viewClass + basic | export | detailed + basic + Defines how much information to display for each element. + + + links + true | false + true + Indicates whether to include links to relevant elements. + + + paging + true | false + true + Indicates whether to return lists of elements in pages. + + + page + number + 1 + Defines which page number to return. + + + pageSize + number + 50 + Defines the number of elements to return for each page. + + + +
+
+
+
Working with the meta-data API With the release of 2.9, a special entry point for meta-data was added in the API, this can be accessed through /api/metaData. This section will give