TPListExPaged

Greg Kolinski edited this page Sep 22, 2017 · 1 revision

Back To Common API Calls


List all Trading Partners in a specified Network/Mailbox with Paging.

 public ECGridIDInfoCollection TPListExPaged(string SessionID, 
                                             int NetworkID, 
                                             int MailboxID, 
                                             bool ShowInactive, 
                                             short PageSize, 
                                             short PageNumber)

Parameters:


Returns

ECGridIDInfoCollection


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 for the Session Network/Mailbox use TPList(). 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";
            int NetworkID = 56845;
            int MailboxID = 5684456;
            bool ShowInactive = false;
            short PageSize = 50;
            short PageNumber = 1;

            ECGridService.ECGridIDInfoCollection TPInfoResults= ECGrid.TPListExPaged(SessionID, NetworkID, MailboxID, ShowInactive, PageSize, PageNumber);

            Console.WriteLine(TPInfoResults.Count);
            if (TPInfoResults.Count > 0)
            {
                foreach (ECGridService.ECGridIDInfo TPInfo in TPInfoResults.ECGridIDInfoList)
                {
                    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 /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/TPListExPaged"

<?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>
    <TPListExPaged xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ShowInactive>boolean</ShowInactive>
      <PageSize>short</PageSize>
      <PageNumber>short</PageNumber>
    </TPListExPaged>
  </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>
    <TPListExPagedResponse xmlns="http://ecgridos.net/">
      <TPListExPagedResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>short</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ECGridIDInfoList>
          <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 xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </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 xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </ECGridIDInfo>
        </ECGridIDInfoList>
      </TPListExPagedResult>
    </TPListExPagedResponse>
  </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>
    <TPListExPaged xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ShowInactive>boolean</ShowInactive>
      <PageSize>short</PageSize>
      <PageNumber>short</PageNumber>
    </TPListExPaged>
  </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>
    <TPListExPagedResponse xmlns="http://ecgridos.net/">
      <TPListExPagedResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>short</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ECGridIDInfoList>
          <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 xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </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 xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </ECGridIDInfo>
        </ECGridIDInfoList>
      </TPListExPagedResult>
    </TPListExPagedResponse>
  </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/TPListExPaged?SessionID=string&NetworkID=string&MailboxID=string&ShowInactive=string&PageSize=string&PageNumber=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"?>
<ECGridIDInfoCollection xmlns="http://ecgridos.net/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>short</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ECGridIDInfoList>
    <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>
    </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>
    </ECGridIDInfo>
  </ECGridIDInfoList>
</ECGridIDInfoCollection>

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

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

<?xml version="1.0" encoding="utf-8"?>
<ECGridIDInfoCollection xmlns="http://ecgridos.net/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>short</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ECGridIDInfoList>
    <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>
    </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>
    </ECGridIDInfo>
  </ECGridIDInfoList>
</ECGridIDInfoCollection>

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.