Deleting a User

You can add a user with the deleteUser method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
userId (required) string ID of the user that you want to delete.

Return Value

When a call is processed successfully, the system returns an object with the following properties:

Parameter Type Description
success bool True, if a user has been deleted

Possible Errors

Error Description
unknown user a user with a given ID cannot be found

Sample Call

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteUserRequest xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Credentials>
        <AccountUrl>http://myaccount.ispringonline.com</EmailAddress>
        <Email>email@email.com</Password>
        <Password>password</Password>
      </Credentials>
      <UserId>1</UserId>
    </DeleteUserRequest>
  </soap:Body>
</soap:Envelope>

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteUserResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Success>true</Success>
    </DeleteUserResult>
  </soap:Body>
</soap:Envelope>