API Documentation

Workspace.RemoveUser

Workspace.RemoveUser

Removes access of the specified user to the specified workspace.

Parameters and required information

Here's a list of all the parameters you'll need to pass to the Workspace.RemoveUser method. All of the parameters are required unless otherwise noted.

SessionKey
The session key obtained from User.Login
WorkspaceID
The ID of the workspace to remove user access
UserID
The ID of the user to remove from the specified workspace

Return Codes

Success

Status: success
Returns a success message.
Status: fail
The call was not successful. Either the session has expired or the XML was not formatted correctly.

Error

5002: Authentication Failure
No active session exists with this session key and developer account id. The user session has expired and the user has to to log on again.
101: The WORKSPACEID attribute is required in the WORSKPACE.REMOVEUSER function
The WORKSPACEID was not passed along.
101: The USERID attribute is required in the WORSKPACE.REMOVEUSER function
The USERID was not passed along.
505: Restricted - This user is not authorized to modify workspaces
This user is not authorized to modify a workspace.
505: Restricted - This user is not authorized to modify users
This user is not authorized to modify users.

HTTP POST

<?xml version="1.0" encoding="utf-8"?>  
<request>  
	<sessionkey>string</sessionkey>
	<workspaceid>integer</workspaceid>
	<userid>integer</userid>     
</request>  
<?xml version="1.0" encoding="utf-8"?>
<mediasilo_response method="Workspace.RemoveUser" status="success">
	<result>
		User removed from Workspace successfully!
	</result>
</mediasilo_response>