Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

If you wish to remove a user from the MyAlerts My Alerts database you will need to call the DeleteUser method to delete the user.  This method is available to developers from the UserManager.

DeleteUser

Input Parameters

The DeleteUser method needs the following parameters:

DeleteUser Input parametersImage Removed

ClientIdasmx Web Service. 

Parameters

 

ClientId

mandatory

This is the id for the client that was returned by the CreateSessionKey method.

SessionKey

mandatory

This is the SessionKey for the client that was returned by the CreateSessionKey method.

UserId

mandatory

This is the unique user

...

id for the user that you wish to delete as stored in the My Alerts database.

Returned Parameters

...

Name

Requirement

Description

 

Returns

Code Block
languagexml
titleSyntax
<DeleteUserResult>
	<Error>
       <Code>int</Code>
       <Description>string</Description>
   </Error>
   <UserId>int</UserId>
   <Success>boolean</Success>
</DeleteUserResult>

 

Error- Code / Description

An error code and description if the call to the web service is unsuccessful and the Success if False.

...

1021 – User not found in the MyAlerts My Alerts database

UserId

This is the UserId that has been generated for the supplied Username in the MyAlerts My Alerts database and will only be returned if the Success is True.

Success

This will be either True or False. If False an error message will be provided in the Error result, if True the UserId will be deleted.