dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #24971
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 815: Minor
------------------------------------------------------------
revno: 815
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sat 2013-09-28 16:03:02 +0200
message:
Minor
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-28 12:41:14 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-09-28 14:03:02 +0000
@@ -2160,7 +2160,7 @@
<entry>ou</entry>
<entry>Yes</entry>
<entry>Organisation unit identifiers in a single parameter value separated by
- ";".</entry>
+ ":".</entry>
<entry>Organisation unit identifiers </entry>
</row>
<row>
@@ -2177,7 +2177,7 @@
<entry>Item identifier including data elements, person attributes and person
identifiers. Can also be the fixed person attributes GENDER and ISDEAD. Parameter
can be repeated any number of times. Filters can be applied to an item on the format
- <item-id>;<operator>;<filter>. Filter values are case-insensitive.</entry>
+ <item-id>:<operator>:<filter>. Filter values are case-insensitive.</entry>
<entry>Operators can be EQ | GT | GE | LT | LE | NE | LIKE | IN</entry>
</row>
<row>
@@ -2212,18 +2212,18 @@
<para>Event queries should be on the format described below. Item identifiers can refer to any
of data elements, person attributes and person identifiers. Items can optionally have a query
operator and a filter.</para>
- <screen>api/analytics/events/query/<program-id>?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&ou=<ou-id>;<ou-id>&item=<item-id>&item=<item-id>;<operator>;<filter></screen>
+ <screen>api/analytics/events/query/<program-id>?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&ou=<ou-id>:<ou-id>&item=<item-id>&item=<item-id>:<operator>:<filter></screen>
<para>For example, to retrieve events from the "Inpatient morbidity and mortality" program
between January and October 2012, where the "Gender" and "Age" data elements are included
and the "Age" item is filtered on "18", you can use the following query:</para>
- <screen>api/analytics/events/query/eBAyeGv0exc?startDate=2012-01-01&endDate=2012-10-31&ou=O6uvpzGd5pu;fdc6uOvgoji&item=oZg33kd9taw&item=qrur9Dvnyt5;EQ;18</screen>
+ <screen>api/analytics/events/query/eBAyeGv0exc?startDate=2012-01-01&endDate=2012-10-31&ou=O6uvpzGd5pu:fdc6uOvgoji&item=oZg33kd9taw&item=qrur9Dvnyt5:EQ:18</screen>
<para>To retrieve events for the "Birth" program stage of the "Child programme" program between
March and December 2012, where the "Weight" data element, filtered for values larger than
2000, and the "Address" person attribute are included:</para>
- <screen>api/analytics/events/query/IpHINAT79UW?stage=A03MvHHogjR&startDate=2012-03-01&endDate=2012-12-31&ou=O6uvpzGd5pu&item=UXz7xuGCEhU;GT;2000&item=AMpUYgxuCaE</screen>
+ <screen>api/analytics/events/query/IpHINAT79UW?stage=A03MvHHogjR&startDate=2012-03-01&endDate=2012-12-31&ou=O6uvpzGd5pu&item=UXz7xuGCEhU:GT:2000&item=AMpUYgxuCaE</screen>
<para>Fixed person attributes can be specified as items as well. Currently the GENDER and
ISDEAD attributes are suppored and can be included and filtered on like this:</para>
- <screen>api/analytics/events/query/IpHINAT79UW?stage=A03MvHHogjR&startDate=2012-03-01&endDate=2012-12-31&ou=O6uvpzGd5pu&item=UXz7xuGCEhU;GT;2000&item=ISDEAD&item=GENDER;EQ;F</screen>
+ <screen>api/analytics/events/query/IpHINAT79UW?stage=A03MvHHogjR&startDate=2012-03-01&endDate=2012-12-31&ou=O6uvpzGd5pu&item=UXz7xuGCEhU:GT:2000&item=ISDEAD&item=GENDER:EQ:F</screen>
<para>Sorting can be applied to the query for the "executiondate" of the event and any items.
To sort descending on the executiondate and ascending on the "Age" data element item you can
use:</para>
@@ -2239,12 +2239,12 @@
<title>Filtering</title>
<para>Filters can be applied to data elements, person attributes and person identifiers. The
filtering is done through the query parameter value on the following format:</para>
- <screen>&item=<item-id>;<operator>;<filter-value></screen>
+ <screen>&item=<item-id>:<operator>:<filter-value></screen>
<para>As an example, you can filter the "Weight" data element for values greater than 2000 and
lower than 4000 like this:</para>
- <screen>&item=UXz7xuGCEhU;GT;2000&item=UXz7xuGCEhU;LT;4000</screen>
+ <screen>&item=UXz7xuGCEhU:GT:2000&item=UXz7xuGCEhU:LT:4000</screen>
<para>You can filter the "Age" data element for multiple, specific ages using the IN operator
- like this:<screen>&item=qrur9Dvnyt5;IN;18:19:20</screen></para>
+ like this:<screen>&item=qrur9Dvnyt5:IN:18;19;20</screen></para>
<para>The available operators are listed below.</para>
<table frame="all">
<title>Filter operators</title>
@@ -2427,12 +2427,12 @@
resource which is described in the previous section. Please make sure you have read the
mentioned section before progressing.</para>
<para>Aggregate event queries should be on the format described below.</para>
- <screen>api/analytics/events/aggregate/<program-id>?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&ou=<ou-id>;<ou-id>&item=<item-id>&item=<item-id>;<operator>;<filter></screen>
+ <screen>api/analytics/events/aggregate/<program-id>?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&ou=<ou-id>:<ou-id>&item=<item-id>&item=<item-id>:<operator>:<filter></screen>
<para>For example, to retrieve aggregate numbers for events from the "Inpatient morbidity and
mortality" program between January and October 2012, where the "Gender" and "Age" data
elements are included, the "Age" item is filtered on "18" and the "Gender" item is filtered on
"Female", you can use the following query:</para>
- <screen>api/analytics/events/aggregate/eBAyeGv0exc?startDate=2012-01-01&endDate=2012-10-31&ou=O6uvpzGd5pu;fdc6uOvgo7ji&item=oZg33kd9taw;EQ;Female&item=qrur9Dvnyt5;EQ;18</screen>
+ <screen>api/analytics/events/aggregate/eBAyeGv0exc?startDate=2012-01-01&endDate=2012-10-31&ou=O6uvpzGd5pu:fdc6uOvgo7ji&item=oZg33kd9taw:EQ:Female&item=qrur9Dvnyt5:EQ:18</screen>
<para>The response will look similar to this:</para>
<screen>{
"headers": [
