UserList

Greg Kolinski edited this page Sep 27, 2017 · 2 revisions

Back To Common API Calls


Get a list of Users for the Session Network/Mailbox.

 public UserIDInfo[] UserList(string SessionID, string Name)

Parameters:


Returns

UserIDInfo[]


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 Session Network/Mailbox.

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

Use UserListEx() to list users in other Network/Mailboxes.


Code Example

C#

using System.Xml;
using System.Web.Services.Protocols;
using ECGridService = <ProjectName>.net.ecgridos;

try
{
    using (ECGridService.ECGridOSAPIv3 ECGrid = new ECGridService.ECGridOSAPIv3())
    {
        try
        {
            string SessionID = "00000000-0000-0000-0000-000000000000";
            string Name = "";

            ECGridService.UserIDInfo[] UserResults = ECGrid.UserList(SessionID, Name);

            foreach (ECGridService.UserIDInfo UserInfo in UserResults)
            {
                Console.WriteLine(UserInfo.UserID);
                Console.WriteLine(UserInfo.LoginName);
                Console.WriteLine(UserInfo.Company);
                Console.WriteLine(UserInfo.Status);
            }
        }
        catch (SoapException SoapEx)
        {
            // See SOAP Exceptions in the Appendix
            var ECG_Ex = CatchException(SoapEx);
            Console.WriteLine($"ECGridOS Soap Exception: {ECG_Ex.ErrorCode} , Item: {ECG_Ex.ErrorItem}, Message: {ECG_Ex.ErrorMessage}, String: {ECG_Ex.ErrorString}");
        }
    } // END USING
}
catch (Exception ex){ Console.WriteLine("Unhandled Exception: " + ex.ToString()); }

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/UserList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UserList xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <Name>string</Name>
    </UserList>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UserListResponse xmlns="http://ecgridos.net/">
      <UserListResult>
        <UserIDInfo>
          <UserID>int</UserID>
          <LoginName>string</LoginName>
          <RecoveryQuestion>string</RecoveryQuestion>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Company>string</Company>
          <EMail>string</EMail>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
          <TimeZoneOffset>short</TimeZoneOffset>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <LastLogin>dateTime</LastLogin>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <LockedOut>boolean</LockedOut>
          <OpenSessions>short</OpenSessions>
        </UserIDInfo>
        <UserIDInfo>
          <UserID>int</UserID>
          <LoginName>string</LoginName>
          <RecoveryQuestion>string</RecoveryQuestion>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Company>string</Company>
          <EMail>string</EMail>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
          <TimeZoneOffset>short</TimeZoneOffset>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <LastLogin>dateTime</LastLogin>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <LockedOut>boolean</LockedOut>
          <OpenSessions>short</OpenSessions>
        </UserIDInfo>
      </UserListResult>
    </UserListResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UserList xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <Name>string</Name>
    </UserList>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UserListResponse xmlns="http://ecgridos.net/">
      <UserListResult>
        <UserIDInfo>
          <UserID>int</UserID>
          <LoginName>string</LoginName>
          <RecoveryQuestion>string</RecoveryQuestion>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Company>string</Company>
          <EMail>string</EMail>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
          <TimeZoneOffset>short</TimeZoneOffset>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <LastLogin>dateTime</LastLogin>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <LockedOut>boolean</LockedOut>
          <OpenSessions>short</OpenSessions>
        </UserIDInfo>
        <UserIDInfo>
          <UserID>int</UserID>
          <LoginName>string</LoginName>
          <RecoveryQuestion>string</RecoveryQuestion>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Company>string</Company>
          <EMail>string</EMail>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
          <TimeZoneOffset>short</TimeZoneOffset>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <LastLogin>dateTime</LastLogin>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <LockedOut>boolean</LockedOut>
          <OpenSessions>short</OpenSessions>
        </UserIDInfo>
      </UserListResult>
    </UserListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v3.2/prod/ecgridos.asmx/UserList?SessionID=string&Name=string HTTP/1.1
Host: ecgridos.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfUserIDInfo xmlns="http://ecgridos.net/">
  <UserIDInfo>
    <UserID>int</UserID>
    <LoginName>string</LoginName>
    <RecoveryQuestion>string</RecoveryQuestion>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Company>string</Company>
    <EMail>string</EMail>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
    <TimeZoneOffset>short</TimeZoneOffset>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <LastLogin>dateTime</LastLogin>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <LockedOut>boolean</LockedOut>
    <OpenSessions>short</OpenSessions>
  </UserIDInfo>
  <UserIDInfo>
    <UserID>int</UserID>
    <LoginName>string</LoginName>
    <RecoveryQuestion>string</RecoveryQuestion>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Company>string</Company>
    <EMail>string</EMail>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
    <TimeZoneOffset>short</TimeZoneOffset>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <LastLogin>dateTime</LastLogin>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <LockedOut>boolean</LockedOut>
    <OpenSessions>short</OpenSessions>
  </UserIDInfo>
</ArrayOfUserIDInfo>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3.2/prod/ecgridos.asmx/UserList HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&Name=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfUserIDInfo xmlns="http://ecgridos.net/">
  <UserIDInfo>
    <UserID>int</UserID>
    <LoginName>string</LoginName>
    <RecoveryQuestion>string</RecoveryQuestion>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Company>string</Company>
    <EMail>string</EMail>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
    <TimeZoneOffset>short</TimeZoneOffset>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <LastLogin>dateTime</LastLogin>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <LockedOut>boolean</LockedOut>
    <OpenSessions>short</OpenSessions>
  </UserIDInfo>
  <UserIDInfo>
    <UserID>int</UserID>
    <LoginName>string</LoginName>
    <RecoveryQuestion>string</RecoveryQuestion>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <Company>string</Company>
    <EMail>string</EMail>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
    <TimeZoneOffset>short</TimeZoneOffset>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <LastLogin>dateTime</LastLogin>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <LockedOut>boolean</LockedOut>
    <OpenSessions>short</OpenSessions>
  </UserIDInfo>
</ArrayOfUserIDInfo>

Back To Common API Calls

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.