NGOGetShortUserProperty

 

This call is used to get only some basic information about multiple userUsers. Complete information about the userUsers is not returned, instead some basic information like first First nName, lLast nName etc. is returned.

 

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.

NGOGetShort

UserProperty

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

UserIndexes

Root

Outer tag containing the lList of User iIndexes. 

 

N/A

UserIndex

User

Indexes

Index of the User whose pProperty is to be fetched.

Integer > 0

N/A

 

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.

Users

Root

Contains information about Users.

User

Users

Information about the a single User.

UserIndex

User

Index of the User.

Name

User

Name of the User.

PersonalName

User

First Name of the User.

FamilyName

User

Last Name of the User.

UserNotFound

Root

Returns index Index of the User for which whose pProperties could not be returned because User with that index not found.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameter.

Some parameters supplied to the call are invalid. For example, e.g. List of User iIndexes whose pProperty is to be fetched is not supplied.

-50058

Specified User does not exist.

User whose pProperty is to be fetched does not n’t exist.

This exception arises only when all the Users for whom whose pProperty is to be fetched do not n’t exist.

 

Warnings returned from call

Code

Message

Comments

50016

Not all Users found.

Properties of all Users could not be returned because some of the Users are not found in the cabinetCabinet.