UserListEx()


Get a list of Users for a specified Network/Mailbox.

Public Function UserListEx(ByVal SessionID As String, _
                           
ByVal NetworkID As Integer, _
                           ByVal MailboxID As Integer, _
                          
ByVal Name As String) _
                          
As UserIDInfo()

Parameters

SessionID
String - GUID
The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of zero (0) lists all Mailboxes for the specified NetworkID, contingent on Authorization Level.
Name
String(i,j)
A generic variable that is used to match any type of Name field (e.g. Network Name, FirstName, LastName, LoginName, etc.).

Returns

UserIDInfo Collection

UserID
Integer
A numeric value used to represent a specific user on the system.
LoginName
String(8,16)
A user's login name.
RecoveryQuestion
String(0,50)
A user defined question used to restore lost password or to activate an account with too many failed logins.
FirstName
String(1,50)
A user's first name.
LastName
String(1,50)
A user's last name.
Company
String(0,50)
A company name.
Email
String(1,50)
A valid Email address.
Phone
String(0,20)
A phone number.
CellPhone
String(0,20)
A Cell Phone number.
CellCarrier
Short - CellCarrier ENUM
A value to indicate the cell phone carrier in order to send SMS text messages.
TimeZoneOffset 
Short
The number of minutes + or - the user local time is from UTC.
NetworkID
Integer
The NetworkID assigned to Network on ECGrid.
MailboxID
Integer
The MailboxID assigned to a Mailbox within a Network on ECGrid.
AuthLevel
Short - AuthLevel ENUM
The Authority Level for system access.
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
LastLogin
Date
The last date/time this User logged in.
Status
Short - ECGridOSv0200.Status ENUM
A numeric value representing the entry's status.
LockedOut
Boolean 
Whether or not the User is currently locked out.
OpenSessions
Short 
Number of current open sessions for this User.

Remarks

The Name parameter is treated as a wildcard and will match all or part of a name in the LoginName, FirstName and LastName fields. If a empty string ("") is passed, it will return all records in the specified Network/Mailbox.

If the specified Mailbox is 0, then all users within the specified Network will be returned.

The current User must have sufficient Authorization Level to request the specified Network/Mailbox; otherwise, a Access Denied SOAP Exception will be generated.

Use UserList() to list users in the Session Network/Mailboxes.

Example

Visual Basic
[insert code sample]

EventID: 1014

See Also

UserList()


© 2008-2011, Loren Data Corp.
All rights reserved.
ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.