ECGridOS API v4


Click here for a complete list of operations.

ParcelUpdateStatus

Update Parcel Status.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
ParcelID:
Status:
TransLogOnly:

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

<?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>
    <ParcelUpdateStatus 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>
      <TransLogOnly>boolean</TransLogOnly>
    </ParcelUpdateStatus>
  </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>
    <ParcelUpdateStatusResponse xmlns="https://os.ecgrid.io/">
      <ParcelUpdateStatusResult>boolean</ParcelUpdateStatusResult>
    </ParcelUpdateStatusResponse>
  </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>
    <ParcelUpdateStatus 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>
      <TransLogOnly>boolean</TransLogOnly>
    </ParcelUpdateStatus>
  </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>
    <ParcelUpdateStatusResponse xmlns="https://os.ecgrid.io/">
      <ParcelUpdateStatusResult>boolean</ParcelUpdateStatusResult>
    </ParcelUpdateStatusResponse>
  </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/ParcelUpdateStatus?SessionID=string&ParcelID=string&Status=string&TransLogOnly=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/ParcelUpdateStatus HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&ParcelID=string&Status=string&TransLogOnly=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>