=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml' --- src/docbkx/en/dhis2_user_man_web_api.xml 2014-01-23 09:45:45 +0000 +++ src/docbkx/en/dhis2_user_man_web_api.xml 2014-01-31 07:54:06 +0000 @@ -3812,6 +3812,39 @@ request to the URL similar to the one used above for retrieval.
+ User settings + You can manipulate user settings by interacting with the userSettings resource. A user setting is a simple key-value pair, where both the + key and the value are plain text strings. The user setting will be linked to the user who is + authenticated for the Web API request. To save or update a user setting you can make a + POST request to the following URL: + /api/userSettings/my-key?value=my-val + Alternatively, you can submit the setting value as the request body, where content type is + set to "text/plain". As an example, you can use curl like this: + curl "apps.dhis2.org/demo/api/userSettings/my-key" -d "My long value" -H "Content-Type: text/plain" -u admin:district -v + You should replace my-key with your real key and my-val with your real value. To retrieve + the value for a given key in plain text you can make a GET + request to the following URL: + /api/userSettings/my-key + To delete a user setting, you can make a DELETE request + to the URL similar to the one used above for retrieval. +
+
+ Configuration + To access configuration you can interact with the configuration resource. You can send GET + requests to the following sub-resources. You can get XML and JSON responses through the + Accept header or by using the .json or .xml + extensions. + /api/configuration/systemId +/api/configuration/feedbackRecipients +/api/configuration/offlineOrganisationUnitLevel +/api/configuration/infrastructuralDataElements +/api/configuration/infrastructuralPeriodType +/api/configuration/selfRegistrationRole +/api/configuration/selfRegistrationOrgUnit +
+
Translations In order to retrieve key-value pairs for translated strings you can use the i18n resource. The endpoint is located at
- User settings - You can manipulate user settings by interacting with the userSettings resource. A user setting is a simple key-value pair, where both the - key and the value are plain text strings. The user setting will be linked to the user who is - authenticated for the Web API request. To save or update a user setting you can make a - POST request to the following URL: - /api/userSettings/my-key?value=my-val - Alternatively, you can submit the setting value as the request body, where content type is - set to "text/plain". As an example, you can use curl like this: - curl "apps.dhis2.org/demo/api/userSettings/my-key" -d "My long value" -H "Content-Type: text/plain" -u admin:district -v - You should replace my-key with your real key and my-val with your real value. To retrieve - the value for a given key in plain text you can make a GET - request to the following URL: - /api/userSettings/my-key - To delete a user setting, you can make a DELETE request - to the URL similar to the one used above for retrieval. -
-
SVG conversion The Web API provides a resource which can be used to convert SVG content into more widely used formats such as PNG and PDF. Ideally this conversion should happen on the client side,