REST API - getUserSettings

The table summarizes the REST API - getUserSettings.

Request

Format
GET <baseurl>/usersettings/<storagekey>/<settingname>
Path parameters
  • storagekey: Identifies the key used to persist data on the server. Must be created using the storagekey attribute in the saveUserSettings operation.
  • settingname: Identifies the specific setting for the value in storagekey. Must be created using the settingname attribute in the saveUserSettings operation.

Response

JSON Returns a JSON representation of the content of the getUserSettingsRsponse element.
XML Returns the content of the getUserSettingsRsponse element (from the UserSettingsService schema).

Example

Request
GET <baseurl>/usersettings/claims/motor
Response
{

  "xml-fragment": {

    "settingProperties": [

      {

        "@Name": "model",

        "@Value": "Accord"

      },

      {

        "@Name": "year",

        "@Value": "2010"

      },

      {

        "@Name": "make",

        "@Value": "Honda"

      }

    ]

  }

}