=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml' --- src/docbkx/en/dhis2_user_man_web_api.xml 2014-03-11 12:14:32 +0000 +++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-03-17 18:41:45 +0000 @@ -1445,7 +1445,7 @@ - The data content of the analytical represantations can be modified by providing a + The data content of the analytical representations can be modified by providing a date query parameter. This requires that the analytical resource is set up for relative periods for the period dimension. @@ -3102,9 +3102,9 @@
Event dimensions - + - + Dimension @@ -3189,7 +3189,7 @@ Yes Dimension identifier including data elements, person attributes, person identifiers, periods and organisation units. Parameter can be repeated any number of - times. Item filtes can be applied to a dimension on the format + times. Item filters can be applied to a dimension on the format <item-id>:<operator>:<filter>. Filter values are case-insensitive. Operators can be EQ | GT | GE | LT | LE | NE | LIKE | IN @@ -3259,14 +3259,13 @@ page No - The page number. Page size of 50 will be used if no page size parameter is - specified. + The page number. Default page is 1. Numeric positive value pageSize No - The page size. Unlimited if not specified. + The page size. Default size is 50 items per page. Numeric zero or positive value @@ -4125,6 +4124,134 @@
+ Tracked Entity Instances + To query for tracked entity instances you can interact with the /trackedEntityInstances resource. This resource supports JSON, JSONP, XLS and + CSV resource representations. +
+ Tracked entity instances query parameters + + + + + + + Query parameter + Required + Description + + + + + item + Yes + Query items referring to attributes. Param can be repeated any number of items. + Filters can be applied to a dimension on the format + <attribute-id>:<operator>:<filter>. Filter values are case-insensitive. + Operators can be EQ | GT | GE | LT | LE | NE | LIKE | IN. Filters can be omitted in + order to simply include the attribute in the response without any constraints. + + + ou + Yes + Organisation unit idenfiers, separated by ";". + + + ouMode + No + The mode of selecting organisation units, can be SELECTED | CHILDREN | + DESCENDANTS. Default is SELECTED, which refers to the selected organisation units + only. CHILDREN refers to immediate children in the hierarchy of the specified org + units. DESCENDANTS refers to all units in the sub-hierarchy of the specified org + units. + + + program + No + Program identifier. Restricts instances to being enrolled in the given + program. + + + trackedEntity + No + Tracked entity identifer. Restricts instances to the given tracked instance + type. + + + page + No + The page number. Default page is 1. + + + pageSize + No + The page size. Default size is 50 items per page. + + + +
+ Note that you can specify items with filters for constraining the instances to return, or + items without filters in order to include the attribute in the response without any + constraints. 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: + api/trackedEntityInstances.json?item=zHXD5Ve1Efw:EQ:A&item=AMpUYgxuCaE&ou=DiszpKrYNg8;yMCshbaVExv + To constrain the response to instances which are part of a specific program you can + include a program query parameter like this: + api/trackedEntityInstances.json?item=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&program=uy2gU8kT1jF + 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: + api/trackedEntityInstances.json?item=zHXD5Ve1Efw:EQ:A&ou=O6uvpzGd5pu&ouMode=DESCENDANTS&page=2&pageSize=3 + You can use a range of operators for the filtering: + + Filter operators + + + + + + Operator + Description + + + + + EQ + Equal to + + + GT + Greater than + + + GE + Greater than or equal to + + + LT + Less than + + + LE + Less than or equal to + + + NE + Not equal to + + + LIKE + Like (free text match) + + + IN + Equal to one of multiple values separated by ":" + + + +
+ +
FRED API DHIS 2 from version 2.11 implements support for the current draft of the FRED API version 1.0. The project defines itself as open standard for sharing and updating