=== 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: <?xml version="1.0" encoding="utf-8"?> -<event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin"> +<event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" status="COMPLETED" storedBy="admin"> <coordinate latitude="59.8" longitude="10.9" /> <dataValues> <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 @@ <?xml version="1.0" encoding="utf-8"?> <events> <eventList> - <event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin"> + <event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" status="COMPLETED" storedBy="admin"> <coordinate latitude="59.8" longitude="10.9" /> <dataValues> <dataValue dataElement="qrur9Dvnyt5" value="22" /> <dataValue dataElement="oZg33kd9taw" value="Male" /> </dataValues> </event> - <event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" completed="true" storedBy="admin"> + <event program="eBAyeGv0exc" orgUnit="DiszpKrYNg8" eventDate="2013-05-17" status="COMPLETED" storedBy="admin"> <coordinate latitude="59.8" longitude="10.9" /> <dataValues> <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 @@ The date of when the event occured - completed - boolean + status + enum false - true | false + ACTIVE, COMPLETED, VISITED,FUTURE_VISIT, + LATE_VISIT,SKIPPED Whether the event is complete or not @@ -2624,6 +2625,24 @@ identifier.
+ Querying for persons + There are several parameter available on the persons + resource for querying for persons, orgUnit paramter is + always required (unless querying for identifiers, please see below). + Query for + orgUnit:GET /api/persons?orgUnit=OU_UID + Query for + orgUnit/program:GET /api/persons?orgUnit=OU_UID&program=PROGRAM_UID + Query for + orgUnit/program/gender:GET /api/persons?orgUnit=OU_UID&program=PROGRAM_UID&gender=MALE/FEMALE/TRANSGENDER + Query for + orgUnit/gender:GET /api/persons?orgUnit=OU_UID&gender=MALE/FEMALE/TRANSGENDER + Query for system + identifier:GET /api/persons?identifier=SYSTEM_ID + Query for specific identifier + type:GET /api/persons?identifierType=ID_TYPE_UID&identifier=ID_VALUE +
+
Enrolling a person into a program For enrolling persons into a program, you will need to first get the identifier of the person from the persons resource, then you will need to