ECGridOS API v2


Click here for a complete list of operations.

InterchangeHeaderInfo

Get Interchange Info from EDI Envelope (ISA or UNB)

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
InterchangeHeader:

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/InterchangeHeaderInfo"

<?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>
    <InterchangeHeaderInfo xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <InterchangeHeader>string</InterchangeHeader>
    </InterchangeHeaderInfo>
  </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>
    <InterchangeHeaderInfoResponse xmlns="http://ecgridos.net/">
      <InterchangeHeaderInfoResult>
        <InterchangeID>long</InterchangeID>
        <InterchangeProcessDate>dateTime</InterchangeProcessDate>
        <NetworkIDFrom>int</NetworkIDFrom>
        <NetworkIDTo>int</NetworkIDTo>
        <Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary</Standard>
        <Bytes>int</Bytes>
        <InterchangeControlID>string</InterchangeControlID>
        <InterchangeDateTime>dateTime</InterchangeDateTime>
        <StatusDate>dateTime</StatusDate>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <DocumentType>string</DocumentType>
        <Header>string</Header>
        <TPFrom>
          <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>
        </TPFrom>
        <TPTo>
          <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>
        </TPTo>
        <Parcels>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Direction>OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
          </ParcelIDInfo>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Direction>OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
          </ParcelIDInfo>
        </Parcels>
      </InterchangeHeaderInfoResult>
    </InterchangeHeaderInfoResponse>
  </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>
    <InterchangeHeaderInfo xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <InterchangeHeader>string</InterchangeHeader>
    </InterchangeHeaderInfo>
  </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>
    <InterchangeHeaderInfoResponse xmlns="http://ecgridos.net/">
      <InterchangeHeaderInfoResult>
        <InterchangeID>long</InterchangeID>
        <InterchangeProcessDate>dateTime</InterchangeProcessDate>
        <NetworkIDFrom>int</NetworkIDFrom>
        <NetworkIDTo>int</NetworkIDTo>
        <Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary</Standard>
        <Bytes>int</Bytes>
        <InterchangeControlID>string</InterchangeControlID>
        <InterchangeDateTime>dateTime</InterchangeDateTime>
        <StatusDate>dateTime</StatusDate>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <DocumentType>string</DocumentType>
        <Header>string</Header>
        <TPFrom>
          <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>
        </TPFrom>
        <TPTo>
          <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>
        </TPTo>
        <Parcels>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Direction>OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
          </ParcelIDInfo>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Direction>OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
          </ParcelIDInfo>
        </Parcels>
      </InterchangeHeaderInfoResult>
    </InterchangeHeaderInfoResponse>
  </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/InterchangeHeaderInfo?SessionID=string&InterchangeHeader=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"?>
<InterchangeIDInfo xmlns="http://ecgridos.net/">
  <InterchangeID>long</InterchangeID>
  <InterchangeProcessDate>dateTime</InterchangeProcessDate>
  <NetworkIDFrom>int</NetworkIDFrom>
  <NetworkIDTo>int</NetworkIDTo>
  <Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary</Standard>
  <Bytes>int</Bytes>
  <InterchangeControlID>string</InterchangeControlID>
  <InterchangeDateTime>dateTime</InterchangeDateTime>
  <StatusDate>dateTime</StatusDate>
  <StatusCode>string</StatusCode>
  <StatusMessage>string</StatusMessage>
  <DocumentType>string</DocumentType>
  <Header>string</Header>
  <TPFrom>
    <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>
  </TPFrom>
  <TPTo>
    <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>
  </TPTo>
  <Parcels>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
      <Direction>OutBox or InBox</Direction>
      <Interchanges>
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Interchanges>
    </ParcelIDInfo>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
      <Direction>OutBox or InBox</Direction>
      <Interchanges>
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Interchanges>
    </ParcelIDInfo>
  </Parcels>
</InterchangeIDInfo>

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

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

<?xml version="1.0" encoding="utf-8"?>
<InterchangeIDInfo xmlns="http://ecgridos.net/">
  <InterchangeID>long</InterchangeID>
  <InterchangeProcessDate>dateTime</InterchangeProcessDate>
  <NetworkIDFrom>int</NetworkIDFrom>
  <NetworkIDTo>int</NetworkIDTo>
  <Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary</Standard>
  <Bytes>int</Bytes>
  <InterchangeControlID>string</InterchangeControlID>
  <InterchangeDateTime>dateTime</InterchangeDateTime>
  <StatusDate>dateTime</StatusDate>
  <StatusCode>string</StatusCode>
  <StatusMessage>string</StatusMessage>
  <DocumentType>string</DocumentType>
  <Header>string</Header>
  <TPFrom>
    <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>
  </TPFrom>
  <TPTo>
    <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>
  </TPTo>
  <Parcels>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
      <Direction>OutBox or InBox</Direction>
      <Interchanges>
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Interchanges>
    </ParcelIDInfo>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
      <Direction>OutBox or InBox</Direction>
      <Interchanges>
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Interchanges>
    </ParcelIDInfo>
  </Parcels>
</InterchangeIDInfo>