Change User's Origin Site

This API can be used to change user's origin site in a multi - microsite setup. The API is a restrictive one and can be called by an admin of the site only. Any other user trying to invoke this API would result in an error being returned by the API. This API also enforces checks that both current origin site of the user and site you want to be changed to, must belong to same namespace. Also, this API won't update origin site of the user, who is an admin in the current origin site.

API Details

Signature of API call

connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);

See details about invoking API in general

Parameter 1 - URI

userService.do

Parameter 2 - UserName

Username of any site administrator

Parameter 3 - Request Parameters

Response

1. Response on successfully updating user's origin site

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

<response code="0">
    <msgs>
         <msg>
             <code>0212</code>
             <value><![CDATA[Origin site updated successfully]]></value>
         </msg>
    </msgs>

</response>

2. Response on user not found

HTTP Response Code = HttpServletResponse.SC_NOT_FOUND

Response XML

<response code="-1">
    <msgs>
         <msg>
             <code>0004</code>
             <value><![CDATA[Unable to find User with matching id]]></value>
         </msg>
    </msgs>
</response>

3. Response for unauthorized access

HTTP Response Code = HttpServletResponse.SC_UNAUTHORIZED

Response XML

<response code="-1">
    <msgs>
         <msg>
             <code>0005</code>
             <value><![CDATA[You are not allowed to perform this action.]]></value>
         </msg>
    </msgs>
</response>

Code Snippet

    /*  Check API Call for detail generic code */
    Map<String, String> parameters = new HashMap<String, String>();
    populateMapForUserUpdate(parameters);
    parameters.put("dispatch", "changeOriginSite");

    parameters.put("originalSiteUrl", "a11.edubrite.com");
   
    String retStr = connection.invokeApi("userService.do", "chenry", parameters);
    System.out.println(retStr);