Social - GUI - UISetup - Update

Owned by Former user (Deleted)
Last updated: May 19, 2015 by andrew johnston (Unlicensed)
1 min read
/social/gui/uisetup/update/{modules}/{query}/{communityids}
/social/gui/uisetup/update/{modules}/{communityids}

(Intended for integration with the Community Edition GUI - not for 3rd party API access)

Updates a users setup so that it can be reloaded next time they log in.

Note that this API call is useful for clearing out saved GUI configurations (eg if it has become corrupt and causes problems on startup), eg: "<server>/api//social/gui/uisetup/update/null/%2A/4c927585d591d31d7b37097a"

Authentication

Required, see Auth - Login

Arguments

modules (required)
List of modules and the necessary information needed to reload them, null if no modules are loaded, the module list is deliminated by ], while individual module arguments are deliminated by ,

query (required)
Last query ran so it can be reloaded into the browser, null if no query has been ran, query pieces are deliminated by ]

communityids (required)
Comma deliminated list of community ids that are currently active

*Note: All arguments must be url encoded (specifically anytime a / is used it must be encoded to %2F so the url processor does not assume you are sending a different API call)

Example

http://infinite.ikanow.com/api/knowledge/uisetup/update/com%2Fikanow%2Finfinit%2Fe%2Fmodules%2F,Maps.swf,Maps,http%3A%2F%2Fwww.sdltridionworld.com%2Fimages%2FGoogleMaps_tcm89-16510.gif/null/abcde12345

Example Response
{
    "response": {
        "action": "UISetup",
        "success": true,
        "message": "modules updated successfully",
        "time": 0
    }
}