NGOSearchUser

This call is used to search userUsers of a particular Ccabinet.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NgoSearchUser

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

 

N/A

UserDBId

Root

UserDatabase ID, which  that is returned in the NGOConnect

Cabinet call.

 

N/A

GroupIndex

Root

Reserreved. User can pass the default value for it.

 

0

UserName

Root

 It specifies the name Name of the User.

 

N/A

Personal Name

Root

First Name of the User.

 

N/A

Family Name

Root

Last Name of the User.

 

N/A

ExpiryDateTime

Root

Date and Time when the object will expire.

 

N/A

SortOrder

Root

It indicates that sorting is to be done on which order, Ascending or Descending.

 

A

OrderBy

Root

A number which that specifies the field on which sorting is to be done.

 

-1

NoOfRecordsTo

Fetch

Root

It indicates the number of records Records to be fetched in a batch.

 

10

StartFrom

Root

It is used for fetching objects in batches. It specifies a number starting from which the next batch of objects is to be fetched.

 

 1

CreationDate

Time

Root

It indicates the Creation date Date time and Time of the User.

 

 

 

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.

NoOfRecordsFetched

Root

It indicates the number of rRecords fetched in a batch.

TotalNoOfRecords

Root

It indicates the total number of rRecords.

Users

Root

A List of Users, starting from the rRoot, is given between <Users> and </Users> tags.

User

Users

A lList of information about the User is given between the <User> and </User> tags.

UserIndex

User

It specifies the unique iIndex of the User.

UserName

User

It specifies the User nameName.

UserInbox

User

Specifies the number of items in InWork folder.

Personal Name

User

First Name of the User.

Family Name

User

Last Name of the User.

CreationDateTime

User

It indicates the Date and Time of creation of User.

ExpiryDateTime

User

Date and Time when the object will expire.

UserAlive

User

It is a flag indicating whether the User account is temporarily disabled or not.

Privileges

User

Seven -bit string specifying the privileges Privileges that the logged in User has in the systemSystem.

UserSentItem

User

Specifies the number of items i.e. actionitems ActionItems and drafts in WorkInProgress fFolder.

UserTrash

User

Specifies the number of items in Trash.

Account

User

It specifies the User Account.

Password

User

It indicates the unique eError cCode of the failed document.

Comment

User

Comment associated with the User.

DeletedDateTime

User

Data and Time when the User was Deleted.