Skip to content

ParcelDownloadConfirmPendingAck

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

Back To Common API Calls


Confirm Download of Parcel wtih Pending Acknowledgment from InBox and remove it.

  public boolean ParcelDownloadConfirmPendingAck(string SessionID,
                                                 long ParcelID,
                                                 ParcelStatus Status)

Parameters


Returns

boolean


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";
            long ParcelID = 46446847;

            bool ParcelDownloadConfirmPendingAckResult = ECGrid.ParcelDownloadConfirmPendingAck(SessionID, ParcelID, ECGridService.ParcelStatus.as2MDNConfirmed);

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

<?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>
    <ParcelDownloadConfirmPendingAck xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <ParcelID>long</ParcelID>
      <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>
    </ParcelDownloadConfirmPendingAck>
  </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>
    <ParcelDownloadConfirmPendingAckResponse xmlns="https://os.ecgrid.io/">
      <ParcelDownloadConfirmPendingAckResult>boolean</ParcelDownloadConfirmPendingAckResult>
    </ParcelDownloadConfirmPendingAckResponse>
  </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>
    <ParcelDownloadConfirmPendingAck xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <ParcelID>long</ParcelID>
      <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>
    </ParcelDownloadConfirmPendingAck>
  </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>
    <ParcelDownloadConfirmPendingAckResponse xmlns="https://os.ecgrid.io/">
      <ParcelDownloadConfirmPendingAckResult>boolean</ParcelDownloadConfirmPendingAckResult>
    </ParcelDownloadConfirmPendingAckResponse>
  </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/ParcelDownloadConfirmPendingAck?SessionID=string&ParcelID=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"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

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

SessionID=string&ParcelID=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"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

Back To Common API Calls

Clone this wiki locally