=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml' --- src/docbkx/en/dhis2_user_man_web_api.xml 2013-07-05 09:55:38 +0000 +++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-07-09 10:12:19 +0000 @@ -762,7 +762,13 @@
Writing and reading messages DHIS 2 features a mechanism for sending messages for purposes such as user feedback, notifications and general information to users. Messages are delivered to the DHIS 2 message inbox but can also be sent to the user's email addresses and mobile phones as SMS. In this example we will see how we can utilize the Web API to send and read messages. We will pretend to be the DHIS Administrator user and send a message to the Mobile user. We will then pretend to be the mobile user and read our new message. - The resource we need to interact with when sending and reading messages is the messageConversations resource. We start by visiting the Web API entry point at where we find and follow the link to the messageConversations resource at . The description tells us that we can use a POST request to create a new message using the following XML format: + The resource we need to interact with when sending and reading messages is the messageConversations resource. We start by visiting the Web API + entry point at where we find and follow the link + to the messageConversations resource at . The description tells us that + we can use a POST request to create a new message using the following XML format for sending + to multiple users: <message xmlns="http://dhis2.org/schema/dxf/2.0"> <subject>This is the subject</subject> <text>This is the text</text> @@ -772,6 +778,26 @@ <user id="user3ID" /> </users> </message> + For sending to all users contained in one or more user groups, we can use: + <message xmlns="http://dhis2.org/schema/dxf/2.0"> + <subject>This is the subject</subject> + <text>This is the text</text> + <userGroups> + <userGroup id="userGroup1ID" /> + <userGroup id="userGroup2ID" /> + <userGroup id="userGroup3ID" /> + </users> +</message> + For sending to all users connected to one or more organisation units, we can use: + <message xmlns="http://dhis2.org/schema/dxf/2.0"> + <subject>This is the subject</subject> + <text>This is the text</text> + <organisationUnits> + <organisationUnit id="ou1ID" /> + <organisationUnit id="ou2ID" /> + <organisationUnit id="ou3ID" /> + </users> +</message> Since we want to send a message to our friend the mobile user we need to look up her identifier. We do so by going to the Web API entry point and follow the link to the users resource at . We continue by following link to the mobile user at where we learn that her identifier is PhzytPW3g2J. We are now ready to put our XML message together to form a message where we want to ask the mobile user whether she has reported data for January 2012: <message xmlns="http://dhis2.org/schema/dxf/2.0"> <subject>Mortality data reporting</subject>