=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2014-07-16 05:57:04 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-07-21 14:52:02 +0000
@@ -1397,6 +1397,56 @@
+ Forms
+ To retrieve information about a form, which corresponds to a data set and its sections,
+ you can interact with the forms resource. The form response
+ is accessible as XML and JSON and will provide information about each section (group) in the
+ form as well as each field in the sections, including label and identifiers. By suppying
+ period and organisation unit identifiers the form response will be populated with data values.
+
+ Form query parameters
+
+
+
+
+
+
+ Parameter
+ Option
+ Description
+
+
+
+
+ pe
+ ISO period
+ Period for which to populate form data values.
+
+
+ ou
+ UID
+ Organisation unit for which to populate form data values.
+
+
+ metaData
+ false | true
+ Whether to include meta-data about each data element and indicator in the data
+ set in the response.
+
+
+
+
+ To retrieve the form for a data set you can do a GET request like this:
+ api/dataSets/<dataset-id>/form.json
+ To retrieve the form for the data set with identifier "BfMAe6Itzgt" in XML:
+ api/dataSets/BfMAe6Itzgt/form
+ To retrieve the form including meta-data in JSON:
+ api/dataSets/BfMAe6Itzgt/form.json?metaData=true
+ To retrieve the form filled with data values for a specific period and organisation unit
+ in XML:
+ api/dataSets/BfMAe6Itzgt/form.xml?ou=DiszpKrYNg8&pe=201401
+
+
Reading complete data set registrations
This section explains how to retrieve data set completeness registrations. We will be using
the completeDataSetRegistrations resource. The query parameters to use are these: