SOAP API - getUserSettingsRequest

The table summarizes the SOAP API - getUserSettingsRequest.

Request Uses the getUserSettingsRequest element (from the UserSettingsService schema)
Parameter notes
  • storageKey: Identifies the key used to persist data on the server. Must be created using the storageKey attribute in the saveUserSettings operation.
  • settingId: Identifies the specific setting for the value in storageKey. Must be created using the settingId attribute in the saveUserSettings operation.
Response Returns a getUserSettingsRsponse element (from the UserSettingsService schema)
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="http://usersettingsservice.api.de.n2.tibco.com">

   <soapenv:Header/>

   <soapenv:Body>

      <user:getUserSettingsRequest>

         <storageKey>configStore</storageKey>

         <settingId>viewSettings</settingId>

      </user:getUserSettingsRequest>

   </soapenv:Body>

</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

      <getUserSettingsResponse xmlns="http://usersettingsservice.api.de.n2.tibco.com">

         <settingProperties Name="listSize" Value="20" xmlns=""/>

         <settingProperties Name="caption" Value="Description" xmlns=""/>

         <settingProperties Name="winSize" Value="600,400" xmlns=""/>

         <settingProperties Name="layout" Value="tabbed" xmlns=""/>

      </getUserSettingsResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>
Contents
Search Results