=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2013-05-30 08:40:18 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-05-30 08:58:07 +0000
@@ -361,12 +361,12 @@
mortality" program for the "Ngelehun CHC" facility in the demo database can be seen
below:
<?xml version='1.0' encoding='utf-8'?>
-<event programId="eBAyeGv0exc" organisationUnitId="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
+<event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
<coordinate latitude="59.8" longitude="10.9" />
<dataValues>
- <dataValue dataElementId="qrur9Dvnyt5" value="22" />
- <dataValue dataElementId="oZg33kd9taw" value="Male" />
- <dataValue dataElementId="msodh3rEMJa" value="2013-05-18" />
+ <dataValue dataElement="qrur9Dvnyt5" value="22" />
+ <dataValue dataElement="oZg33kd9taw" value="Male" />
+ <dataValue dataElement="msodh3rEMJa" value="2013-05-18" />
</dataValues>
</event>
To perform some testing we can save the XML payload as a file calledcurl -d @events.xml "localhost:8080/api/events" -H "Content-Type:application/xml" -u admin:district -v
The same payload in JSON format looks like this:
{
- "programId": "eBAyeGv0exc",
- "organisationUnitId": "DiszpKrYNg8",
+ "program": "eBAyeGv0exc",
+ "orgUnit": "DiszpKrYNg8",
"eventDate": "2013-05-17",
"completed": true,
"storedBy": "admin",
@@ -385,9 +385,9 @@
"longitude": "10.9"
},
"dataValues": [
- { "dataElementId": "qrur9Dvnyt5", "value": "22" },
- { "dataElementId": "oZg33kd9taw", "value": "Male" },
- { "dataElementId": "msodh3rEMJa", "value": "2013-05-18" }
+ { "dataElement": "qrur9Dvnyt5", "value": "22" },
+ { "dataElement": "oZg33kd9taw", "value": "Male" },
+ { "dataElement": "msodh3rEMJa", "value": "2013-05-18" }
]
}
To send this you can save it to a file called <?xml version='1.0' encoding='utf-8'?>
<events>
<eventList>
- <event programId="eBAyeGv0exc" organisationUnitId="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
+ <event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
<coordinate latitude="59.8" longitude="10.9" />
<dataValues>
- <dataValue dataElementId="qrur9Dvnyt5" value="22" />
- <dataValue dataElementId="oZg33kd9taw" value="Male" />
+ <dataValue dataElement="qrur9Dvnyt5" value="22" />
+ <dataValue dataElement="oZg33kd9taw" value="Male" />
</dataValues>
</event>
- <event programId="eBAyeGv0exc" organisationUnitId="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
+ <event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
<coordinate latitude="59.8" longitude="10.9" />
<dataValues>
- <dataValue dataElementId="qrur9Dvnyt5" value="26" />
- <dataValue dataElementId="oZg33kd9taw" value="Female" />
+ <dataValue dataElement="qrur9Dvnyt5" value="26" />
+ <dataValue dataElement="oZg33kd9taw" value="Female" />
</dataValues>
</event>
</eventList>
@@ -420,8 +420,8 @@
{
"eventList": [
{
- "programId": "eBAyeGv0exc",
- "organisationUnitId": "DiszpKrYNg8",
+ "program": "eBAyeGv0exc",
+ "orgUnit": "DiszpKrYNg8",
"eventDate": "2013-05-17",
"completed": true,
"storedBy": "admin",
@@ -430,12 +430,12 @@
"longitude": "10.9"
},
"dataValues": [
- { "dataElementId": "qrur9Dvnyt5", "value": "22" },
- { "dataElementId": "oZg33kd9taw", "value": "Male" }
+ { "dataElement": "qrur9Dvnyt5", "value": "22" },
+ { "dataElement": "oZg33kd9taw", "value": "Male" }
] },
{
- "programId": "eBAyeGv0exc",
- "organisationUnitId": "DiszpKrYNg8",
+ "program": "eBAyeGv0exc",
+ "orgUnit": "DiszpKrYNg8",
"eventDate": "2013-05-17",
"completed": true,
"storedBy": "admin",
@@ -444,12 +444,12 @@
"longitude": "10.9"
},
"dataValues": [
- { "dataElementId": "qrur9Dvnyt5", "value": "26" },
- { "dataElementId": "oZg33kd9taw", "value": "Female" }
+ { "dataElement": "qrur9Dvnyt5", "value": "26" },
+ { "dataElement": "oZg33kd9taw", "value": "Female" }
] }
]
}
- The table below describes the meaning of each element. Most elements should be reasonably
+ The table below describes the meaning of each element. Most elements should be fairly
self-explanatory.