dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #31187
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1112: Minor fix
------------------------------------------------------------
revno: 1112
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2014-06-27 09:58:24 +0200
message:
Minor fix
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-06-26 15:29:25 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-06-27 07:58:24 +0000
@@ -4772,37 +4772,35 @@
<para>A query on all attributes for a specific value and organisation unit, using an exact word
match:</para>
<screen>api/trackedEntityInstances.json?query=scott&ou=DiszpKrYNg8</screen>
- <para>A query on all attributes for a specif value, using a partial word match:</para>
+ <para>A query on all attributes for a specific value, using a partial word match:</para>
<screen>api/trackedEntityInstances.json?query=LIKE:scott&ou=DiszpKrYNg8</screen>
<para>You can query on multiple words separated by the the URL character for space which is
%20, will use a logical AND query for each word:</para>
<screen>api/trackedEntityInstances.json?query=isabel%20may&ou=DiszpKrYNg8</screen>
- <para>A query where the attributes to include in th response are specified looks like
- this:</para>
+ <para>A query where the attributes to include in the response are specified:</para>
<screen>api/trackedEntityInstances.json?query=isabel&attribute=dv3nChNSIxy&attribute=AMpUYgxuCaE&ou=DiszpKrYNg8</screen>
<para>To query for instances using one attribute with a filter and one attribute without a
- filter, with one organisation unit using the descendants organisation unit query mode, you can
- issue a query like this:</para>
+ filter, with one organisation unit using the descendants organisation unit query
+ mode:</para>
<screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&attribute=AMpUYgxuCaE&ou=DiszpKrYNg8;yMCshbaVExv</screen>
<para>A query for instances where one attribute is included in the response and one attribute us
- used as a filter can look like this:</para>
+ used as a filter:</para>
<screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&filter=AMpUYgxuCaE:LIKE:Road&ou=DiszpKrYNg8</screen>
- <para>To query on an attribute using multiple values in an IN filter you can do like
- this:</para>
+ <para>To query on an attribute using multiple values in an IN filter:</para>
<screen>api/trackedEntityInstances.json?ou=DiszpKrYNg8&attribute=dv3nChNSIxy:IN:Scott;Jimmy;Santiago</screen>
<para>To constrain the response to instances which are part of a specific program you can
- include a program query parameter like this:</para>
+ include a program query parameter:</para>
<screen>api/trackedEntityInstances.json?filter=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&program=ur1Edk5Oe2n</screen>
- <para>To specify program enrollment dates as part of the query you can use this syntax:</para>
+ <para>To specify program enrollment dates as part of the query:</para>
<screen>api/trackedEntityInstances.json?filter=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&program=ur1Edk5Oe2n&programStartDate=2013-01-01&programEndDate=2013-09-01</screen>
<para>To constrain the response to instances of a specific tracked entity you can include a
- tracked entity query parameter like this:</para>
+ tracked entity query parameter:</para>
<screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&trackedEntity=cyl5vuJ5ETQ</screen>
<para>By default the instances are returned in pages of size 50, to change this you can use the
- page and pageSize query parameters like this:</para>
+ page and pageSize query parameters:</para>
<screen>api/trackedEntityInstances.json?attribute=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&page=2&pageSize=3</screen>
- <para>To query for instances which have events of a given status within a given time span you
- can use this syntax:</para>
+ <para>To query for instances which have events of a given status within a given time
+ span:</para>
<screen>api/trackedEntityInstances.json?ou=O6uvpzGd5pu&program=ur1Edk5Oe2n&eventStatus=LATE_VISIT&eventStartDate=2014-01-01&eventEndDate=2014-09-01</screen>
<para>You can use a range of operators for the filtering:</para>
<table frame="all">