NGOAddUser

This transaction is used to add a new User to the System.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml
Errors and Warnings

Input Parameters description

Name	Parent Tag	Description	Valid Values	Default Values
Option	Root	Unique option for the call.	NGOAddUser	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID that is returned in the NGOConnect Cabinet call.		N/A
User	Root	This is an outer tag containing information about the new User to be added.
Name	User	Name of the User.		New User (Incremental number) For example if New User(1) is already there then a new user with name New User(2) will be added.
Password	User	Password of the User.		Blank
PersonalName	User	First Name of the User.		Blank
FamilyName	User	Last name of the User.		Blank
CreationDate Time	User	Date and Time of creation of the User.	Valid Date in the format yyyy-mm-dd hh:mm:ss	Current Date and time.
Privileges	User	Specifies the various Privileges assigned to the User.	String of seven bits, each 0 or 1 depending upon whether that particular privilege is to be given to the User or not.	None Privileges assigned to the new User.
Comment	User	Any comment associated with the User.		Blank
Account	User	Specifies the type of account of the User. 0 – Normal Account 1 – Super Account By default, all the Users in the System have a Normal account and only the Supervisor User has System account.		0
CompanyFolder Id	User	Reserved for internal use.
LimitCount	User	Specifies the maximum number of Users that can be added in the System.		No check is made for limit on number of Users
ExpiryDateTime	User	Date and Time of expiry of the User account.	Valid Date and Time in the format yyyy-mm-dd hh:mm:ss	31/12/2090
GroupIndex	User	Group Index to which the User is to be added.
MailId	User	Mail id of the user.		NULL
Fax	User	Fax number of the user.		NULL
NoteColor	User	Color preference of the user.		NULL
SuperiorIndex	User	Superior index of the new user.		NULL
SuperiorFlag	User	Flag indicates whether superior is a User or a Role of a group.	‘U’ or ‘G’
ParentGroupIndex	User	Parent Group index of the new user to be added.		NULL
PasswordExpiryTime	User	Expiry date & time of password.
PasswordNeverExpires	User	Password never expires flag indicating whether password expires or not.	‘Y’ or ‘N’	‘Y’

Output Parameters description

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.
ImageVolumeIndex	Root	Volume Index of Image Server where the documents uploaded by the User will be added or where System documents are added.
User	Root	Information of the added User.
UserIndex	User	Index of the User.
Name	User	Name of the User.
PersonalName	User	Personal name of the User.
FamilyName	User	Family name of the User.
CreationDateTime	User	Date and Time of creation of the User.
ExpiryDateTime	User	Date and Time of expiry of the User.
Privileges	User	Privileges of the User.
Password	User	Password for the User.
Comment	User	Comment associated with the User.
Account	User	Specifies the Type of account of the User. 0 – Normal Account 1 – Super Account
DeletedDateTime	User	Date and Time of deletion of the User.
UserAlive	User	Indicates whether User is Alive or Not Alive – ‘Y’ or ‘N’.
MailId	User	Mail id of the user.
Fax	User	Fax number of the user.
NoteColor	User	Color preference of the user.
Folders	Root	Encloses information about the Inbox, SentItems, Trash and Attachment folders.
Folder	Folders	Outer tag that contains information about a single folder.
UserInbox	Folder	Index of Inbox Folder of the User
FolderIndex	Folder	Index of the folder.
ParentFolderIndex	Folder	Index of parent of the folder.
FolderName	Folder	Name of the folder.
OwnerIndex	Folder	Index of the Owner of the folder.
CreationDateTime	Folder	Date and Time at which the folder was created
RevisedDateTime	Folder	Date and Time at which the folder was last modified.
AccessDateTime	Folder	Date and Time at which the folder was last accessed.
DeletedDateTime	Folder	Date and Time when the folder was deleted.
AccessType	Folder	Indicates whether the folder is a Shared folder / Private folder / Inherits its Access Type from its Parent Folder.
ImageVolumeIndex	Folder	Volume Index of the Image Server where the documents of this folder will be added.
FolderType	Folder	Indicates the Type of the folder.
FolderLock	Folder	Indicates if any User has locked the folder.
Location	Folder	It specifies the location where the folder is present.
ExpiryDateTime	Folder	Date and Time after which the folder will expire.
VersionFlag	Folder	Indicates whether Versioning will be allowed for the documents added in this folder or not.
Comment	Folder	Comments associated with the folder.
FinalizedFlag	Folder	Indicates whether the Folder is finalized or not.
FinalizedDateTime	Folder	Date and Time when the folder was finalized.
ACLMoreFlag	Folder	Not Used.
DataDefIndex	Folder	Index of the data class associated with this folder.
AddedGroups	Root	Information about the Groups to which the User is added successfully.
GroupIndex	Added Groups	Index of the Group to which the User is added successfully.
FailedGroups	Root	Information about the Groups to which the User could not be added successfully.
FailedGroup	FailedGroups	Information about the Group to which the User could not be added successfully.
GroupIndex	Failed Groups	Index of the Group to which the User could not be added successfully.
StatusCode	Failed Groups	Code for failure.

Errors returned from call

Code	Message	Comments
-50009	User with the same name already exists.	User with the Name specified in the call already exists in the System.
-50177	Limit on number of Users exceeded.	User could not be added since the limit on the number of Users has been exceeded.
-50116	Insufficient privileges for the current operation.	Logged in User does not have Privilege for adding a User in the System.
-50017	Folder not found.	Reserved for internal use.