This call is
used for deleting an existing User from the System. When a User is deleted from
the System, all its related information is deleted from the System. For example,
Its Inbox Folder, Sent Item Folder etc.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGODelete User |
N/A |
|
CabinetName |
Root |
Name of the Cabinet to which the User wants to connect. |
|
N/A |
|
UserDBId |
Root |
UserDatabase IDthat is returned in the NGOConnect Cabinet call. |
|
N/A |
|
UserIndex |
Root |
Index of the User to be deleted. |
Integer > 0 |
N/A |
|
NameLength |
Root |
Reserved for internal use. |
|
|
|
TransferSys Documents |
Root |
Indicates whether documents in the System Folders (namely
Inbox, SentItems, Trash) of the User being deleted are to be transferred to
the corresponding System Folders of the User who is deleting or not. |
‘Y - Yes ‘N’- No |
Y |
|
SuperiorIndex |
Root |
Superior index of the user to be deleted. |
|
|
|
SuperiorFlag |
Root |
Flag indicates whether superior is a User or a Role of a
group. |
‘U’ or ‘G’ |
|
|
Name |
Parent Tag |
Description |
|
Option |
Root |
Unique option for the call. |
|
Status |
Root |
Status of the call. If the Status is 0, then the call is
successful. |
|
Code |
Message |
Comments |
|
-50084 |
Supervisor
cannot be deleted. |
Supervisor
User cannot be deleted. |
|
-50062 |
Logged in
User cannot perform operation on self. |
Logged in
User cannot delete self. |
|
-50058 |
Specified
User does not exist. |
User to
be deleted does not exist in the System. |
|
-50116 |
Insufficient
privileges for the current operation. |
Logged in
User does not have Privilege for deleting a User from the System. |
|
-50023 |
Document
not found |
Document
to be deleted does not exist. |
|
-50170 |
Document
is deleted or moved. |
Document
to be deleted has already been moved to some other Folder or deleted. |
|
-50017 |
Folder
not found. |
Parent
Folder of the document that is to be deleted is not found. |
|
-50021 |
Folder is
in use. |
Parent
Folder of the document to be deleted has been locked by some User other than
the logged in User. |
|
-50026 |
Document
is in use. |
Document
to be deleted has been locked. |
|
-50071 |
Document
has been checked out. |
Document
to be deleted has been checked out. |
|
-50022 |
Insufficient
rights for the current operation. |
Document
could not be deleted as logged in User does not have Rights for deleting the
document. |