ParcelInBoxArchiveEx

Greg Kolinski edited this page Sep 20, 2017 · 1 revision

Back To Common API Calls


InBox Archive List for a specified Network/Mailbox.

 public ParcelIDInfoCollection ParcelInBoxArchiveEx(string SessionID, 
                                                  int NetworkID, 
                                                  int MailboxID, 
                                                  System.DateTime BeginDate, 
                                                  System.DateTime EndDate, 
                                                  int ECGridIDFrom, 
                                                  int ECGridIDTo, 
                                                  string MailbagControlID, 
                                                  short PageNo, 
                                                  short RecordsPerPage)

Parameters:


Returns

ParcelIDInfoCollection


Remarks

This method returns a list of from a specified Network/Mailbox InBox Archive. The actual content and manifest are kept on-line for at least 90-days, after that this information can be retrieved from ECGrid NetOps.

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

The list may be filtered by providing non-zero values for ECGridIDFrom or ECGridIDTo. At least one of the two when provided must be in the specified Network/Mailbox.

The maximum span between BeginDate and EndDate is 31 days.

To run reports on the Session Network/Mailbox use ParcelInBoxArchive().


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;
            int ECGridIDFrom = 567;
            int ECGridIDTo = 4844;
            string MailbagControlID = ""; // Optional
            short PageNo = 1;
            short RecordsPerPage = 10;

            ECGridService.ParcelIDInfoCollection ParcelInboxResults = ECGrid.ParcelInBoxArchiveEx(SessionID, NetworkID, MailboxID, BeginDate, EndDate, ECGridIDFrom, ECGridIDTo, MailbagControlID, PageNo, RecordsPerPage);

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

                foreach (var Parcel in InBoxParcels)
                {
                    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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/ParcelInBoxArchiveEx"

<?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>
    <ParcelInBoxArchiveEx xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <BeginDate>dateTime</BeginDate>
      <EndDate>dateTime</EndDate>
      <ECGridIDFrom>int</ECGridIDFrom>
      <ECGridIDTo>int</ECGridIDTo>
      <MailbagControlID>string</MailbagControlID>
      <PageNo>short</PageNo>
      <RecordsPerPage>short</RecordsPerPage>
    </ParcelInBoxArchiveEx>
  </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>
    <ParcelInBoxArchiveExResponse xmlns="http://ecgridos.net/">
      <ParcelInBoxArchiveExResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>short</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ParcelIDInfoList>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <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>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
          </ParcelIDInfo>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <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>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
          </ParcelIDInfo>
        </ParcelIDInfoList>
      </ParcelInBoxArchiveExResult>
    </ParcelInBoxArchiveExResponse>
  </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 /v3.2/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>
    <ParcelInBoxArchiveEx xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <BeginDate>dateTime</BeginDate>
      <EndDate>dateTime</EndDate>
      <ECGridIDFrom>int</ECGridIDFrom>
      <ECGridIDTo>int</ECGridIDTo>
      <MailbagControlID>string</MailbagControlID>
      <PageNo>short</PageNo>
      <RecordsPerPage>short</RecordsPerPage>
    </ParcelInBoxArchiveEx>
  </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>
    <ParcelInBoxArchiveExResponse xmlns="http://ecgridos.net/">
      <ParcelInBoxArchiveExResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>short</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ParcelIDInfoList>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <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>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
          </ParcelIDInfo>
          <ParcelIDInfo>
            <ParcelID>long</ParcelID>
            <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>
            <StatusDate>dateTime</StatusDate>
            <StatusCode>string</StatusCode>
            <StatusMessage>string</StatusMessage>
            <LocalStatus>short</LocalStatus>
            <LocalStatusDate>dateTime</LocalStatusDate>
            <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</Valid>
            <Acknowledgment>string</Acknowledgment>
            <Direction>NoDir or OutBox or InBox</Direction>
            <Interchanges xsi:nil="true" />
            <Log xsi:nil="true" />
          </ParcelIDInfo>
        </ParcelIDInfoList>
      </ParcelInBoxArchiveExResult>
    </ParcelInBoxArchiveExResponse>
  </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 /v3.2/prod/ecgridos.asmx/ParcelInBoxArchiveEx?SessionID=string&NetworkID=string&MailboxID=string&BeginDate=string&EndDate=string&ECGridIDFrom=string&ECGridIDTo=string&MailbagControlID=string&PageNo=string&RecordsPerPage=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"?>
<ParcelIDInfoCollection xmlns="http://ecgridos.net/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>short</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ParcelIDInfoList>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <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>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</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>
    </ParcelIDInfo>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <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>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</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>
    </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 /v3.2/prod/ecgridos.asmx/ParcelInBoxArchiveEx HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&MailboxID=string&BeginDate=string&EndDate=string&ECGridIDFrom=string&ECGridIDTo=string&MailbagControlID=string&PageNo=string&RecordsPerPage=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="http://ecgridos.net/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>short</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ParcelIDInfoList>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <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>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</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>
    </ParcelIDInfo>
    <ParcelIDInfo>
      <ParcelID>long</ParcelID>
      <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>
      <StatusDate>dateTime</StatusDate>
      <StatusCode>string</StatusCode>
      <StatusMessage>string</StatusMessage>
      <LocalStatus>short</LocalStatus>
      <LocalStatusDate>dateTime</LocalStatusDate>
      <Valid>Pending or Invalid or Valid or ValidPartialRouted or ValidNoneRouted</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>
    </ParcelIDInfo>
  </ParcelIDInfoList>
</ParcelIDInfoCollection>

Back To Common API Calls

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.