dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 983
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2014-03-19 09:57:30 +0100
message:
  tracked entity CRUD docs
modified:
  src/docbkx/en/dhis2_user_man_web_api.xml


--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs

Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription

=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml	2014-03-19 08:30:44 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-03-19 08:57:30 +0000
@@ -4020,8 +4020,22 @@
     </table>
   </section>
   <section>
+    <title>Tracked entity management</title>
+    <para>Tracked entity have full CRUD (create, read, update, delete) support in the Web-API. A tracked entity only have two required
+      property, <emphasis role="italic">name</emphasis> and <emphasis role="italic">description</emphasis>.</para>
+    <para>
+      <screen>{
+  "name": "Name of tracked entity",
+  "description": "Description of tracked entity"
+}</screen>
+    </para>
+    <para>This payload can be sent to the <emphasis role="italic">trackedEntities</emphasis> resource, both <emphasis role="bold"
+        >POST</emphasis> and <emphasis role="bold">PUT</emphasis> are supported. For deleting a tracked entity you must use the <emphasis
+        role="bold">DELETE</emphasis> method at the <emphasis role="italic">/api/trackedEntities/UID</emphasis> resource.</para>
+  </section>
+  <section>
     <title>Tracked entity instance management</title>
-    <para>Persons have full CRUD (create, read, update, delete) support in the Web-API. Together with the API for enrollment most operations
+    <para>Tracked entity instances have full CRUD (create, read, update, delete) support in the Web-API. Together with the API for enrollment most operations
       needed for working with tracked entity instances and programs are supported.</para>
     <section>
       <title>Creating a new tracked entity instance</title>