=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml' --- src/docbkx/en/dhis2_user_man_web_api.xml 2013-08-17 09:26:48 +0000 +++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-08-22 11:16:33 +0000 @@ -1880,6 +1880,40 @@ }
+ API for third party data entry client + DHIS 2 includes many APIs for fetching resouces from the system. These can be data + elements, indicators, organisation units, etc, but this API is not really well suited when you + want to build your own third party client and only need information specific to the users + assigned data sets / programs. From DHIS 2.13, we also support an additional API for easily + building your own data entry client. This API is only available in JSON, since a third party + client in most cases these days will be a mobile client, or a client written in + JavaScript. + All the APIs for this have a starting point at http://<server-url>/api/currentUser/*: + http://<server-url>/api/currentUser Gives basic + information about the user that you are currently logged in as, including username, user + credentials, assigned organisation units. + http://<server-url>/api/currentUser/dashboard Gives + information about currently unread messages and interpretations. + http://<server-url>/api/currentUser/inbox Lists all + messages and interpretations in the inbox (including replies). + http://<server-url>/api/currentUser/user-account Gives + the full profile information for current user. This endpoint support both GET to retrieve profile and POST + to update profile (the exact same format is used), + http://<server-url>/api/currentUser/assignedDataSets + Gives all the datasets assigned to the users organisation units, and their direct children. + This endpoint contains all required information to build a form based on one of our datasets. + If you want all descendants of your assigned organisation units, you can use the query + parameter includeDescendants=true. + http://<server-url>/api/currentUser/assignedPrograms + Gives all the programs assigned to the users organisation units, and their direct children. + This endpoint contains all required information to build a form based on one of our datasets. + If you want all descendants of your assigned organisation units, you can use the query + parameter includeDescendants=true. Currently only single + event with no registration is supported. +
+
FRED API DHIS 2 from version 2.11 implements support for the current draft of the FRED API version 1.0. The project defines itself as open standard for sharing and updating