dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #27120
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 913: Minor
------------------------------------------------------------
revno: 913
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2013-12-27 16:56:51 +0100
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-12-27 14:20:33 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-12-27 15:56:51 +0000
@@ -1146,21 +1146,21 @@
</thead>
<tbody>
<row>
- <entry>APPROVED</entry>
+ <entry>"APPROVED"</entry>
<entry>Data in this data set is approved for this period and organisation unit</entry>
</row>
<row>
- <entry>READY_FOR_APPROVAL</entry>
+ <entry>"READY_FOR_APPROVAL"</entry>
<entry>Data in this data set is ready to be approved for this period and organisation
unit</entry>
</row>
<row>
- <entry>WAITING_FOR_LOWER_LEVEL_APPROVAL</entry>
+ <entry>"WAITING_FOR_LOWER_LEVEL_APPROVAL"</entry>
<entry>Data is not ready to be approved because it is waiting for approval at a
lower-level organisation unit</entry>
</row>
<row>
- <entry>APPROVAL_NOT_NEEDED</entry>
+ <entry>"APPROVAL_NOT_NEEDED"</entry>
<entry>Data does not need approval because approval is not required or data set is not
collected at organisation unit</entry>
</row>
@@ -3531,20 +3531,31 @@
role="italic">me</emphasis> resource (you can also refer to it by its old name <emphasis role="italic">currentUser</emphasis>). The current user related
resources gives your information which is useful when building clients for instance for data entry and user management. The following describes these
resources and their purpose.</para>
- <para><emphasis role="bold">http://<server-url>/api/me</emphasis> Gives basic information about the user that you are currently logged in as, including
- username, user credentials, assigned organisation units.</para>
- <para><emphasis role="bold">http://<server-url>/api/me/dashboard</emphasis> Gives information about currently unread messages and interpretations.</para>
- <para><emphasis role="bold">http://<server-url>/api/me/inbox</emphasis> Lists all messages and interpretations in the inbox (including replies).</para>
- <para><emphasis role="bold">http://<server-url>/api/me/user-account</emphasis> Gives the full profile information for current user. This endpoint support
- both <emphasis role="italic">GET</emphasis> to retrieve profile and <emphasis role="italic">POST</emphasis> to update profile (the exact same format is
- used),</para>
- <para><emphasis role="bold">http://<server-url>/api/me/organisationUnits</emphasis> Lists all organisation units directly assigned to the user.</para>
- <para><emphasis role="bold">http://<server-url>/api/me/dataSets</emphasis> Gives all the datasets assigned to the users organisation units, and their
- direct children. This endpoint contains all required information to build a form based on one of our datasets. If you want all descendants of your
- assigned organisation units, you can use the query parameter <emphasis role="italic">includeDescendants=true</emphasis>.</para>
- <para><emphasis role="bold">http://<server-url>/api/me/programs</emphasis> Gives all the programs assigned to the users organisation units, and their
- direct children. This endpoint contains all required information to build a form based on one of our datasets. If you want all descendants of your
- assigned organisation units, you can use the query parameter <emphasis role="italic">includeDescendants=true</emphasis>.</para>
+ <para><emphasis role="bold">/api/me</emphasis> Gives basic information about the user that you
+ are currently logged in as, including username, user credentials, assigned organisation
+ units.</para>
+ <para><emphasis role="bold">/api/me/dashboard</emphasis> Gives information about currently
+ unread messages and interpretations.</para>
+ <para><emphasis role="bold">/api/me/inbox</emphasis> Lists all messages and interpretations in
+ the inbox (including replies).</para>
+ <para><emphasis role="bold">/api/me/user-account</emphasis> Gives the full profile information
+ for current user. This endpoint support both <emphasis role="italic">GET</emphasis> to
+ retrieve profile and <emphasis role="italic">POST</emphasis> to update profile (the exact same
+ format is used).</para>
+ <para><emphasis role="bold">/api/me/authorization/<auth></emphasis> Returns true or false,
+ indicating whether the current user has been granted the given <auth> authorization.</para>
+ <para><emphasis role="bold">/api/me/organisationUnits</emphasis> Lists all organisation units
+ directly assigned to the user.</para>
+ <para><emphasis role="bold">/api/me/dataSets</emphasis> Gives all the datasets assigned to the
+ users organisation units, and their direct children. This endpoint contains all required
+ information to build a form based on one of our datasets. If you want all descendants of your
+ assigned organisation units, you can use the query parameter <emphasis role="italic"
+ >includeDescendants=true</emphasis>.</para>
+ <para><emphasis role="bold">/api/me/programs</emphasis> Gives all the programs assigned to the
+ users organisation units, and their direct children. This endpoint contains all required
+ information to build a form based on one of our datasets. If you want all descendants of your
+ assigned organisation units, you can use the query parameter <emphasis role="italic"
+ >includeDescendants=true</emphasis>.</para>
</section>
<section>
<title>System settings</title>