Skip to content

WhoAmI

Jump to bottom
Greg Kolinski edited this page Sep 25, 2017 · 3 revisions

Back To Common API Calls

Returns current session information.

 public SessionInfo WhoAmI(string SessionID)

Parameters:

Returns

SessionInfo

Remarks

This is purely an informational call and can be used to verify system functionality. It does not require a login.

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";

            ECGridService.SessionInfo Results = ECGrid.WhoAmI(SessionID);

        }
        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/WhoAmI"

<?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>
    <WhoAmI xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
    </WhoAmI>
  </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>
    <WhoAmIResponse xmlns="http://ecgridos.net/">
      <WhoAmIResult>
        <ECGridOSVersion>string</ECGridOSVersion>
        <SessionID>string</SessionID>
        <SessionEventID>int</SessionEventID>
        <UserID>int</UserID>
        <LoginName>string</LoginName>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <EMail>string</EMail>
        <Phone>string</Phone>
        <TimeZoneOffset>float</TimeZoneOffset>
        <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
        <LastLogin>dateTime</LastLogin>
        <OpenSessions>short</OpenSessions>
        <TimeOut>short</TimeOut>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <ip>string</ip>
      </WhoAmIResult>
    </WhoAmIResponse>
  </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>
    <WhoAmI xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
    </WhoAmI>
  </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>
    <WhoAmIResponse xmlns="http://ecgridos.net/">
      <WhoAmIResult>
        <ECGridOSVersion>string</ECGridOSVersion>
        <SessionID>string</SessionID>
        <SessionEventID>int</SessionEventID>
        <UserID>int</UserID>
        <LoginName>string</LoginName>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <EMail>string</EMail>
        <Phone>string</Phone>
        <TimeZoneOffset>float</TimeZoneOffset>
        <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
        <LastLogin>dateTime</LastLogin>
        <OpenSessions>short</OpenSessions>
        <TimeOut>short</TimeOut>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <ip>string</ip>
      </WhoAmIResult>
    </WhoAmIResponse>
  </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/WhoAmI?SessionID=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"?>
<SessionInfo xmlns="http://ecgridos.net/">
  <ECGridOSVersion>string</ECGridOSVersion>
  <SessionID>string</SessionID>
  <SessionEventID>int</SessionEventID>
  <UserID>int</UserID>
  <LoginName>string</LoginName>
  <FirstName>string</FirstName>
  <LastName>string</LastName>
  <Company>string</Company>
  <EMail>string</EMail>
  <Phone>string</Phone>
  <TimeZoneOffset>float</TimeZoneOffset>
  <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
  <LastLogin>dateTime</LastLogin>
  <OpenSessions>short</OpenSessions>
  <TimeOut>short</TimeOut>
  <NetworkID>int</NetworkID>
  <MailboxID>int</MailboxID>
  <ip>string</ip>
</SessionInfo>

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/WhoAmI HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<SessionInfo xmlns="http://ecgridos.net/">
  <ECGridOSVersion>string</ECGridOSVersion>
  <SessionID>string</SessionID>
  <SessionEventID>int</SessionEventID>
  <UserID>int</UserID>
  <LoginName>string</LoginName>
  <FirstName>string</FirstName>
  <LastName>string</LastName>
  <Company>string</Company>
  <EMail>string</EMail>
  <Phone>string</Phone>
  <TimeZoneOffset>float</TimeZoneOffset>
  <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
  <LastLogin>dateTime</LastLogin>
  <OpenSessions>short</OpenSessions>
  <TimeOut>short</TimeOut>
  <NetworkID>int</NetworkID>
  <MailboxID>int</MailboxID>
  <ip>string</ip>
</SessionInfo>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally