Skip to content

TPList

Jump to bottom
Lee Bolgatz edited this page Oct 28, 2022 · 2 revisions

Back To Common API Calls

List all Trading Partners in the Session Network/Mailbox.

  public ECGridIDInfo[] TPList(string SessionID,
                               boolean ShowInactive)

Parameters

Returns

ECGridIDInfo[]

Remarks

When ShowInactive is True both Suspended and Terminated records are returned. In this way, historical data can be retrieved for any ECGridID.

To list Trading Partners by a specific Network/Mailbox use TPListEx(). To list by Qualifier/ID use TPSearch().

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";
            bool ShowInactive = false;

            ECGridService.ECGridIDInfo[] TPInfoResults= ECGrid.TPList(SessionID, ShowInactive);

            foreach (ECGridService.ECGridIDInfo TPInfo in TPInfoResults)
            {
                Console.WriteLine(TPInfo.ECGridID);
                Console.WriteLine(TPInfo.Qualifier);
                Console.WriteLine(TPInfo.ID);
                Console.WriteLine(TPInfo.Description);
            }

        }
        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 /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://os.ecgrid.io/TPList"

<?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>
    <TPList xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <ShowInactive>boolean</ShowInactive>
    </TPList>
  </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>
    <TPListResponse xmlns="https://os.ecgrid.io/">
      <TPListResult>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <MailboxID>int</MailboxID>
          <MailboxName>string</MailboxName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <MailboxDefault>boolean</MailboxDefault>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <Owner>
            <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>
          </Owner>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
            <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
          </OwnerInfo>
          <Config>
            <InBoxTimeout>short</InBoxTimeout>
            <SegTerm>unsignedByte</SegTerm>
            <ElmSep>unsignedByte</ElmSep>
            <SubElmSep>unsignedByte</SubElmSep>
            <EBCDICFilter>short</EBCDICFilter>
            <FTPasciiFilter>boolean</FTPasciiFilter>
            <LowPassFilter>boolean</LowPassFilter>
            <MailbagPassThrough>boolean</MailbagPassThrough>
            <DeleteOnDownload>boolean</DeleteOnDownload>
            <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
          </Config>
        </ECGridIDInfo>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <MailboxID>int</MailboxID>
          <MailboxName>string</MailboxName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <MailboxDefault>boolean</MailboxDefault>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <Owner>
            <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>
          </Owner>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
            <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
          </OwnerInfo>
          <Config>
            <InBoxTimeout>short</InBoxTimeout>
            <SegTerm>unsignedByte</SegTerm>
            <ElmSep>unsignedByte</ElmSep>
            <SubElmSep>unsignedByte</SubElmSep>
            <EBCDICFilter>short</EBCDICFilter>
            <FTPasciiFilter>boolean</FTPasciiFilter>
            <LowPassFilter>boolean</LowPassFilter>
            <MailbagPassThrough>boolean</MailbagPassThrough>
            <DeleteOnDownload>boolean</DeleteOnDownload>
            <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
          </Config>
        </ECGridIDInfo>
      </TPListResult>
    </TPListResponse>
  </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 /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
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>
    <TPList xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <ShowInactive>boolean</ShowInactive>
    </TPList>
  </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>
    <TPListResponse xmlns="https://os.ecgrid.io/">
      <TPListResult>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <MailboxID>int</MailboxID>
          <MailboxName>string</MailboxName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <MailboxDefault>boolean</MailboxDefault>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <Owner>
            <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>
          </Owner>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
            <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
          </OwnerInfo>
          <Config>
            <InBoxTimeout>short</InBoxTimeout>
            <SegTerm>unsignedByte</SegTerm>
            <ElmSep>unsignedByte</ElmSep>
            <SubElmSep>unsignedByte</SubElmSep>
            <EBCDICFilter>short</EBCDICFilter>
            <FTPasciiFilter>boolean</FTPasciiFilter>
            <LowPassFilter>boolean</LowPassFilter>
            <MailbagPassThrough>boolean</MailbagPassThrough>
            <DeleteOnDownload>boolean</DeleteOnDownload>
            <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
          </Config>
        </ECGridIDInfo>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <MailboxID>int</MailboxID>
          <MailboxName>string</MailboxName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <MailboxDefault>boolean</MailboxDefault>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <Owner>
            <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>
          </Owner>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
            <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
          </OwnerInfo>
          <Config>
            <InBoxTimeout>short</InBoxTimeout>
            <SegTerm>unsignedByte</SegTerm>
            <ElmSep>unsignedByte</ElmSep>
            <SubElmSep>unsignedByte</SubElmSep>
            <EBCDICFilter>short</EBCDICFilter>
            <FTPasciiFilter>boolean</FTPasciiFilter>
            <LowPassFilter>boolean</LowPassFilter>
            <MailbagPassThrough>boolean</MailbagPassThrough>
            <DeleteOnDownload>boolean</DeleteOnDownload>
            <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
          </Config>
        </ECGridIDInfo>
      </TPListResult>
    </TPListResponse>
  </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 /v4.1/prod/ECGridOS.asmx/TPList?SessionID=string&ShowInactive=string HTTP/1.1
Host: os.ecgrid.io

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfECGridIDInfo xmlns="https://os.ecgrid.io/">
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <MailboxID>int</MailboxID>
    <MailboxName>string</MailboxName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <MailboxDefault>boolean</MailboxDefault>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <Owner>
      <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>
    </Owner>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
      <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
    </OwnerInfo>
    <Config>
      <InBoxTimeout>short</InBoxTimeout>
      <SegTerm>unsignedByte</SegTerm>
      <ElmSep>unsignedByte</ElmSep>
      <SubElmSep>unsignedByte</SubElmSep>
      <EBCDICFilter>short</EBCDICFilter>
      <FTPasciiFilter>boolean</FTPasciiFilter>
      <LowPassFilter>boolean</LowPassFilter>
      <MailbagPassThrough>boolean</MailbagPassThrough>
      <DeleteOnDownload>boolean</DeleteOnDownload>
      <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
    </Config>
  </ECGridIDInfo>
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <MailboxID>int</MailboxID>
    <MailboxName>string</MailboxName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <MailboxDefault>boolean</MailboxDefault>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <Owner>
      <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>
    </Owner>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
      <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
    </OwnerInfo>
    <Config>
      <InBoxTimeout>short</InBoxTimeout>
      <SegTerm>unsignedByte</SegTerm>
      <ElmSep>unsignedByte</ElmSep>
      <SubElmSep>unsignedByte</SubElmSep>
      <EBCDICFilter>short</EBCDICFilter>
      <FTPasciiFilter>boolean</FTPasciiFilter>
      <LowPassFilter>boolean</LowPassFilter>
      <MailbagPassThrough>boolean</MailbagPassThrough>
      <DeleteOnDownload>boolean</DeleteOnDownload>
      <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
    </Config>
  </ECGridIDInfo>
</ArrayOfECGridIDInfo>

HTTP POST

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

POST /v4.1/prod/ECGridOS.asmx/TPList HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfECGridIDInfo xmlns="https://os.ecgrid.io/">
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <MailboxID>int</MailboxID>
    <MailboxName>string</MailboxName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <MailboxDefault>boolean</MailboxDefault>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <Owner>
      <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>
    </Owner>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
      <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
    </OwnerInfo>
    <Config>
      <InBoxTimeout>short</InBoxTimeout>
      <SegTerm>unsignedByte</SegTerm>
      <ElmSep>unsignedByte</ElmSep>
      <SubElmSep>unsignedByte</SubElmSep>
      <EBCDICFilter>short</EBCDICFilter>
      <FTPasciiFilter>boolean</FTPasciiFilter>
      <LowPassFilter>boolean</LowPassFilter>
      <MailbagPassThrough>boolean</MailbagPassThrough>
      <DeleteOnDownload>boolean</DeleteOnDownload>
      <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
    </Config>
  </ECGridIDInfo>
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <MailboxID>int</MailboxID>
    <MailboxName>string</MailboxName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <MailboxDefault>boolean</MailboxDefault>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <Owner>
      <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>
    </Owner>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
      <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
    </OwnerInfo>
    <Config>
      <InBoxTimeout>short</InBoxTimeout>
      <SegTerm>unsignedByte</SegTerm>
      <ElmSep>unsignedByte</ElmSep>
      <SubElmSep>unsignedByte</SubElmSep>
      <EBCDICFilter>short</EBCDICFilter>
      <FTPasciiFilter>boolean</FTPasciiFilter>
      <LowPassFilter>boolean</LowPassFilter>
      <MailbagPassThrough>boolean</MailbagPassThrough>
      <DeleteOnDownload>boolean</DeleteOnDownload>
      <StripDirectedEnvelope>boolean</StripDirectedEnvelope>
    </Config>
  </ECGridIDInfo>
</ArrayOfECGridIDInfo>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally