Skip to content

ParcelInBoxExShort

Jump to bottom
Lee Bolgatz edited this page Oct 28, 2022 · 1 revision

Back To Common API Calls

Current InBox for a specified Network/Mailbox - short form.

  public short ParcelInBoxExShort(string SessionID,
                                  int NetworkID,
                                  int MailboxID,
                                  int ECGridIDFrom,
                                  int ECGridIDTo,
                                  ParcelStatus Status)

Parameters

Returns

short

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

<?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>
    <ParcelInBoxExShort xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ECGridIDFrom>int</ECGridIDFrom>
      <ECGridIDTo>int</ECGridIDTo>
      <Status>InBoxReady or InBoxTransferred or x1256Pending or as2Receive or as2MDNSent or as2MDNPending or as2MDNRejected or as2MDNConfirmed or as2Sent or as2SendFailed or gisbReceived or gisbSent or gisbSendFailed or cxmlReceived or cxmlSent or cxmlSendFailed or ftpReceived or x400Received or smtpReceived or oftpReceived</Status>
    </ParcelInBoxExShort>
  </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>
    <ParcelInBoxExShortResponse xmlns="https://os.ecgrid.io/">
      <ParcelInBoxExShortResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>int</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ParcelIDInfoList>
          <ParcelIDInfo>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <ActualBytes>int</ActualBytes>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <MailboxNameFrom>string</MailboxNameFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <MailboxNameTo>string</MailboxNameTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <ArchiveDate>dateTime</ArchiveDate>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
            <ParcelID>long</ParcelID>
          </ParcelIDInfo>
          <ParcelIDInfo>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <ActualBytes>int</ActualBytes>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <MailboxNameFrom>string</MailboxNameFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <MailboxNameTo>string</MailboxNameTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <ArchiveDate>dateTime</ArchiveDate>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
            <ParcelID>long</ParcelID>
          </ParcelIDInfo>
        </ParcelIDInfoList>
      </ParcelInBoxExShortResult>
    </ParcelInBoxExShortResponse>
  </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>
    <ParcelInBoxExShort xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ECGridIDFrom>int</ECGridIDFrom>
      <ECGridIDTo>int</ECGridIDTo>
      <Status>InBoxReady or InBoxTransferred or x1256Pending or as2Receive or as2MDNSent or as2MDNPending or as2MDNRejected or as2MDNConfirmed or as2Sent or as2SendFailed or gisbReceived or gisbSent or gisbSendFailed or cxmlReceived or cxmlSent or cxmlSendFailed or ftpReceived or x400Received or smtpReceived or oftpReceived</Status>
    </ParcelInBoxExShort>
  </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>
    <ParcelInBoxExShortResponse xmlns="https://os.ecgrid.io/">
      <ParcelInBoxExShortResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>int</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ParcelIDInfoList>
          <ParcelIDInfo>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <ActualBytes>int</ActualBytes>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <MailboxNameFrom>string</MailboxNameFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <MailboxNameTo>string</MailboxNameTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <ArchiveDate>dateTime</ArchiveDate>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
            <ParcelID>long</ParcelID>
          </ParcelIDInfo>
          <ParcelIDInfo>
            <ParcelBytes>int</ParcelBytes>
            <ParcelDate>dateTime</ParcelDate>
            <ActualBytes>int</ActualBytes>
            <NetworkIDFrom>int</NetworkIDFrom>
            <NetworkNameFrom>string</NetworkNameFrom>
            <MailboxIDFrom>int</MailboxIDFrom>
            <MailboxNameFrom>string</MailboxNameFrom>
            <NetworkIDTo>int</NetworkIDTo>
            <NetworkNameTo>string</NetworkNameTo>
            <MailboxIDTo>int</MailboxIDTo>
            <MailboxNameTo>string</MailboxNameTo>
            <FileName>string</FileName>
            <MailbagControlID>string</MailbagControlID>
            <ArchiveDate>dateTime</ArchiveDate>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
            <ParcelID>long</ParcelID>
          </ParcelIDInfo>
        </ParcelIDInfoList>
      </ParcelInBoxExShortResult>
    </ParcelInBoxExShortResponse>
  </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/ParcelInBoxExShort?SessionID=string&NetworkID=string&MailboxID=string&ECGridIDFrom=string&ECGridIDTo=string&Status=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"?>
<ParcelIDInfoCollection xmlns="https://os.ecgrid.io/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>int</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ParcelIDInfoList>
    <ParcelIDInfo>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <ActualBytes>int</ActualBytes>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <MailboxNameFrom>string</MailboxNameFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <MailboxNameTo>string</MailboxNameTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <ArchiveDate>dateTime</ArchiveDate>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
      <Acknowledgment>string</Acknowledgment>
      <Direction>NoDir or 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>
      <Log>
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Log>
      <ParcelID>long</ParcelID>
    </ParcelIDInfo>
    <ParcelIDInfo>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <ActualBytes>int</ActualBytes>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <MailboxNameFrom>string</MailboxNameFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <MailboxNameTo>string</MailboxNameTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <ArchiveDate>dateTime</ArchiveDate>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
      <Acknowledgment>string</Acknowledgment>
      <Direction>NoDir or 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>
      <Log>
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Log>
      <ParcelID>long</ParcelID>
    </ParcelIDInfo>
  </ParcelIDInfoList>
</ParcelIDInfoCollection>

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/ParcelInBoxExShort HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&MailboxID=string&ECGridIDFrom=string&ECGridIDTo=string&Status=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ParcelIDInfoCollection xmlns="https://os.ecgrid.io/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>int</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ParcelIDInfoList>
    <ParcelIDInfo>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <ActualBytes>int</ActualBytes>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <MailboxNameFrom>string</MailboxNameFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <MailboxNameTo>string</MailboxNameTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <ArchiveDate>dateTime</ArchiveDate>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
      <Acknowledgment>string</Acknowledgment>
      <Direction>NoDir or 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>
      <Log>
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Log>
      <ParcelID>long</ParcelID>
    </ParcelIDInfo>
    <ParcelIDInfo>
      <ParcelBytes>int</ParcelBytes>
      <ParcelDate>dateTime</ParcelDate>
      <ActualBytes>int</ActualBytes>
      <NetworkIDFrom>int</NetworkIDFrom>
      <NetworkNameFrom>string</NetworkNameFrom>
      <MailboxIDFrom>int</MailboxIDFrom>
      <MailboxNameFrom>string</MailboxNameFrom>
      <NetworkIDTo>int</NetworkIDTo>
      <NetworkNameTo>string</NetworkNameTo>
      <MailboxIDTo>int</MailboxIDTo>
      <MailboxNameTo>string</MailboxNameTo>
      <FileName>string</FileName>
      <MailbagControlID>string</MailbagControlID>
      <ArchiveDate>dateTime</ArchiveDate>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid>
      <Acknowledgment>string</Acknowledgment>
      <Direction>NoDir or 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>
      <Log>
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Log>
      <ParcelID>long</ParcelID>
    </ParcelIDInfo>
  </ParcelIDInfoList>
</ParcelIDInfoCollection>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally