Application Settings API

[DRAFT] This document is not yet official. It is posted only for reference.

Application Settings API allows registered third party applications to save its own application setting in the Imonggo account the user.

Application settings are account wide, i.e. apply to entire account. Imonggo does not currently support settings that are branch specific.

This API supports 3 operations:

  1. Saving of Settings
  2. Listing of Settings
  3. Deletion of Settings

PUT (Saving)

Example:

In this example, we saving to test_account the settings for application_1.

curl http://test_account.imonggo.com/api/application_settings/application_1.xml \
-u aff6eddabb606c3db397a0df684497802c0b2cfc:X \
-H "Accept: application/xml" \
-H "Content-Type: application/xml" \
-X PUT \
-d @settings.xml

Sample contents of settings.xml

<settings>
    <version>1.3</version>
    <support_table>1</support_table>
    <default_category_name>Food</default_category_name>
</settings>

GET (Retrieving)

This example will retrieve all the settings of application_1 from test_account.

Example:

curl http://test_account.imonggo.com/api/application_settings/application_1.xml \
-u aff6eddabb606c3db397a0df684497802c0b2cfc:X \

DELETE

Example:

This example will delete all the settings of application_1 from test_account.

curl http://test_account.imonggo.com/api/application_settings/application_1.xml \
-u aff6eddabb606c3db397a0df684497802c0b2cfc:X \
-H "Accept: application/xml" \
-H "Content-Type: application/xml" \
-X DELETE