ECGridOS API v2


Click here for a complete list of operations.

TPSearchEx

Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair in a specified Network/Mailbox.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
NetworkID:
MailboxID:
Qualifier:
ID:
ShowInactive:

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 /v2.3/prod/ECGridOS.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/TPSearchEx"

<?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>
    <TPSearchEx xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <Qualifier>string</Qualifier>
      <ID>string</ID>
      <ShowInactive>boolean</ShowInactive>
    </TPSearchEx>
  </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>
    <TPSearchExResponse xmlns="http://ecgridos.net/">
      <TPSearchExResult>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <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>
          </OwnerInfo>
        </ECGridIDInfo>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <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>
          </OwnerInfo>
        </ECGridIDInfo>
      </TPSearchExResult>
    </TPSearchExResponse>
  </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 /v2.3/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>
    <TPSearchEx xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <Qualifier>string</Qualifier>
      <ID>string</ID>
      <ShowInactive>boolean</ShowInactive>
    </TPSearchEx>
  </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>
    <TPSearchExResponse xmlns="http://ecgridos.net/">
      <TPSearchExResult>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <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>
          </OwnerInfo>
        </ECGridIDInfo>
        <ECGridIDInfo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <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>
          </OwnerInfo>
        </ECGridIDInfo>
      </TPSearchExResult>
    </TPSearchExResponse>
  </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 /v2.3/prod/ECGridOS.asmx/TPSearchEx?SessionID=string&NetworkID=string&MailboxID=string&Qualifier=string&ID=string&ShowInactive=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"?>
<ArrayOfECGridIDInfo xmlns="http://ecgridos.net/">
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <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>
    </OwnerInfo>
  </ECGridIDInfo>
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <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>
    </OwnerInfo>
  </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 /v2.3/prod/ECGridOS.asmx/TPSearchEx HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&MailboxID=string&Qualifier=string&ID=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="http://ecgridos.net/">
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <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>
    </OwnerInfo>
  </ECGridIDInfo>
  <ECGridIDInfo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <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>
    </OwnerInfo>
  </ECGridIDInfo>
</ArrayOfECGridIDInfo>