Skip to content

ParcelOutBoxError

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

Back To Common API Calls


List of Parcels which could not be processed for the Session Network/Mailbox.

  public short ParcelOutBoxError(string SessionID,
                                 dateTime BeginDate,
                                 dateTime EndDate)

Parameters


Returns

short


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

            ECGridService.ParcelIDInfoCollection ParcelOutBoxErrorResults = ECGrid.ParcelOutBoxError(SessionID, BeginDate, EndDate);

            Console.WriteLine(ParcelOutBoxErrorResults.Count);
            if (ParcelOutBoxErrorResults.Count > 0)
            {
                 ECGridService.ParcelIDInfo[] BoxParcels = ParcelOutBoxErrorResults.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/ParcelOutBoxError"

<?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>
    <ParcelOutBoxError xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <BeginDate>dateTime</BeginDate>
      <EndDate>dateTime</EndDate>
    </ParcelOutBoxError>
  </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>
    <ParcelOutBoxErrorResponse xmlns="https://os.ecgrid.io/">
      <ParcelOutBoxErrorResult>
        <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>
      </ParcelOutBoxErrorResult>
    </ParcelOutBoxErrorResponse>
  </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>
    <ParcelOutBoxError xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <BeginDate>dateTime</BeginDate>
      <EndDate>dateTime</EndDate>
    </ParcelOutBoxError>
  </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>
    <ParcelOutBoxErrorResponse xmlns="https://os.ecgrid.io/">
      <ParcelOutBoxErrorResult>
        <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>
      </ParcelOutBoxErrorResult>
    </ParcelOutBoxErrorResponse>
  </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/ParcelOutBoxError?SessionID=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/ParcelOutBoxError HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=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

Clone this wiki locally