dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 811
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2013-09-27 14:28:47 +0200
message:
  update section of person querying, also update section on sending events (including new status flag)
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	2013-09-26 10:10:50 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-09-27 12:28:47 +0000
@@ -382,7 +382,7 @@
       events from the "Inpatient morbidity and mortality" program for the "Ngelehun CHC" facility in
       the demo database can be seen below:</para>
     <screen>&lt;?xml version="1.0" encoding="utf-8"?>
-&lt;event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
+&lt;event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" status="COMPLETED" storedBy="admin">
   &lt;coordinate latitude="59.8" longitude="10.9" />
   &lt;dataValues>
     &lt;dataValue dataElement="qrur9Dvnyt5" value="22" />
@@ -398,7 +398,7 @@
   "program": "eBAyeGv0exc",
   "orgUnit": "DiszpKrYNg8",
   "eventDate": "2013-05-17",
-  "completed": true,
+  "status": "COMPLETED",
   "storedBy": "admin",
   "coordinate": {
     "latitude": "59.8",
@@ -417,14 +417,14 @@
     <screen>&lt;?xml version="1.0" encoding="utf-8"?>
 &lt;events>
   &lt;eventList>
-    &lt;event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
+    &lt;event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" status="COMPLETED" storedBy="admin">
       &lt;coordinate latitude="59.8" longitude="10.9" />
       &lt;dataValues>
         &lt;dataValue dataElement="qrur9Dvnyt5" value="22" />
         &lt;dataValue dataElement="oZg33kd9taw" value="Male" />
       &lt;/dataValues>
     &lt;/event>
-    &lt;event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin">
+    &lt;event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" status="COMPLETED" storedBy="admin">
       &lt;coordinate latitude="59.8" longitude="10.9" />
       &lt;dataValues>
         &lt;dataValue dataElement="qrur9Dvnyt5" value="26" />
@@ -442,7 +442,7 @@
     "program": "eBAyeGv0exc",
     "orgUnit": "DiszpKrYNg8",
     "eventDate": "2013-05-17",
-    "completed": true,
+    "status": "COMPLETED",
     "storedBy": "admin",
     "coordinate": {
       "latitude": "59.8",
@@ -456,7 +456,7 @@
     "program": "eBAyeGv0exc",
     "orgUnit": "DiszpKrYNg8",
     "eventDate": "2013-05-17",
-    "completed": true,
+    "status": "COMPLETED",
     "storedBy": "admin",
     "coordinate": {
       "latitude": "59.8",
@@ -529,10 +529,11 @@
               <entry>The date of when the event occured</entry>
             </row>
             <row>
-              <entry>completed</entry>
-              <entry>boolean</entry>
+              <entry>status</entry>
+              <entry>enum</entry>
               <entry>false</entry>
-              <entry>true | false</entry>
+              <entry>ACTIVE, COMPLETED, VISITED,<para>FUTURE_VISIT,
+                  LATE_VISIT,</para><para>SKIPPED</para></entry>
               <entry>Whether the event is complete or not</entry>
             </row>
             <row>
@@ -2624,6 +2625,24 @@
         identifier.</para>
     </section>
     <section>
+      <title>Querying for persons</title>
+      <para>There are several parameter available on the <emphasis role="italic">persons</emphasis>
+        resource for querying for persons, <emphasis role="italic">orgUnit</emphasis> paramter is
+        always required (unless querying for identifiers, please see below).</para>
+      <para><emphasis role="bold">Query for
+        orgUnit:</emphasis><screen>GET /api/persons?orgUnit=OU_UID</screen></para>
+      <para><emphasis role="bold">Query for
+        orgUnit/program:</emphasis><screen>GET /api/persons?orgUnit=OU_UID&amp;program=PROGRAM_UID</screen></para>
+      <para><emphasis role="bold">Query for
+        orgUnit/program/gender:</emphasis><screen>GET /api/persons?orgUnit=OU_UID&amp;program=PROGRAM_UID&amp;gender=MALE/FEMALE/TRANSGENDER</screen></para>
+      <para><emphasis role="bold">Query for
+        orgUnit/gender:</emphasis><screen>GET /api/persons?orgUnit=OU_UID&amp;gender=MALE/FEMALE/TRANSGENDER</screen></para>
+      <para><emphasis role="bold">Query for system
+        identifier:</emphasis><screen>GET /api/persons?identifier=SYSTEM_ID</screen></para>
+      <para><emphasis role="bold">Query for specific identifier
+        type:</emphasis><screen>GET /api/persons?identifierType=ID_TYPE_UID&amp;identifier=ID_VALUE</screen></para>
+    </section>
+    <section>
       <title>Enrolling a person into a program</title>
       <para>For enrolling persons into a program, you will need to first get the identifier of the
         person from the <emphasis role="italic">persons</emphasis> resource, then you will need to