Skip to content

ParcelOutBoxErrorEx

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

Back To Common API Calls

List of Parcels which could not be processed for a specified Network/Mailbox.

  public short ParcelOutBoxErrorEx(string SessionID,
                                   int NetworkID,
                                   int MailboxID,
                                   dateTime BeginDate,
                                   dateTime EndDate)

Parameters

Returns

short

Remarks

The method returns a list of Parcels that have a Valid value of other than ParcelValid.Valid (1) for a specified Network/Mailbox.

The current User must have the proper Authorization Level to query the specified Network/Mailbox or a SOAP Exception will be thrown.

The Valid values are defined as follows:

ParcelValid.Invalid (0) There was something structurally wrong with the Parcel, and it could not be processed. The problems with the Parcel need to be corrected and resubmitted. ParcelNoteList() may be of assistance in finding the problem. ParcelValid.ValidPartialRouted (2) The structure of the Parcel is valid; however, in a multi-Interchange Parcel (not recommended) some of the Interchanges had known Receiver Qualifier/IDs, some did not. The suspended Interchange(s) will be forwarded if a matching Trading Partner Qualifier/ID is added to ECGrid within 30 days.

TPTo = nothing, indicates that the Interchange could not be routed.

ParcelValid.ValidNoneRouted (3) The structure of the Parcel is valid; however, no Interchange(s) had known Receiver Qualifier/IDs. The suspended Interchange(s) will be forwarded if a matching Trading Partner Qualifier/ID is added to ECGrid within 30 days.

TPTo = nothing, indicates that the Interchange could not be routed.

The maximum span between BeginDate and EndDate is 31 days.

To create an OutBox error report for the Session Network/Mailbox use ParcelOutBoxError().

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;
            DateTime BeginDate = DateTime.Now.AddDays(-7);
            DateTime EndDate = DateTime.Now;

            ECGridService.ParcelIDInfoCollection ParcelOutBoxErrorExResults = ECGrid.ParcelOutBoxErrorEx(SessionID, NetworkID, MailboxID, BeginDate, EndDate);

            Console.WriteLine(ParcelOutBoxErrorExResults.Count);
            if (ParcelOutBoxErrorExResults.Count > 0)
            {
                 ECGridService.ParcelIDInfo[] BoxParcels = ParcelOutBoxErrorExResults.ParcelIDInfoList;

                 foreach (var Parcel in BoxParcels)
                 {
                     Console.WriteLine(Parcel.ParcelID);
                     Console.WriteLine(Parcel.StatusCode);
                     Console.WriteLine(Parcel.FileName);
                     Console.WriteLine(Parcel.Acknowledgment);
                 }
            }

        }
        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/ParcelOutBoxErrorEx"

<?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>
    <ParcelOutBoxErrorEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <BeginDate>dateTime</BeginDate>
      <EndDate>dateTime</EndDate>
    </ParcelOutBoxErrorEx>
  </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>
    <ParcelOutBoxErrorExResponse xmlns="https://os.ecgrid.io/">
      <ParcelOutBoxErrorExResult>
        <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>
      </ParcelOutBoxErrorExResult>
    </ParcelOutBoxErrorExResponse>
  </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>
    <ParcelOutBoxErrorEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <BeginDate>dateTime</BeginDate>
      <EndDate>dateTime</EndDate>
    </ParcelOutBoxErrorEx>
  </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>
    <ParcelOutBoxErrorExResponse xmlns="https://os.ecgrid.io/">
      <ParcelOutBoxErrorExResult>
        <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>
      </ParcelOutBoxErrorExResult>
    </ParcelOutBoxErrorExResponse>
  </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/ParcelOutBoxErrorEx?SessionID=string&NetworkID=string&MailboxID=string&BeginDate=string&EndDate=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/ParcelOutBoxErrorEx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&MailboxID=string&BeginDate=string&EndDate=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