Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

If you wish to remove a user from the MyAlerts database you will need to call the DeleteUser method to delete the user.

DeleteUser

Input Parameters

The DeleteUser method needs the following parameters:

DeleteUser Input parameters

ClientId

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

SessionKey

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

UserId

This is the unique user name for the user that you wish to delete.

Returned Parameters

The following parameters will be returned:

Syntax
<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.

1001 – Invalid Session key provided

1021 – User not found in the MyAlerts database

UserId

This is the UserId that has been generated for the supplied Username in the MyAlerts 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.

  • No labels