ParcelInBoxEx - LorenData/ECGrid-API GitHub Wiki
Current InBox for a specified Network/Mailbox.
public short ParcelInBoxEx(string SessionID,
int NetworkID,
int MailboxID,
int ECGridIDFrom,
int ECGridIDTo)- SessionID - String - GUID
- NetworkID - Integer
- MailboxID - Integer
- ECGridIDFrom - Integer
- ECGridIDTo - Integer
short
A list of all Parcels pending download in a specified Session Network/Mailbox.
Use ParcelDownload() to download the Parcels through ECGridOS. Alternatively, they may be accessed through other communications channels such as FTP or AS2.
Use ParcelDownloadConfirm() to confirm successful download of a Parcel through ECGridOS and remove it from the pending list.
To list Parcels from the Session Network/Mailbox use ParcelInBox().
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;
int ECGridIDFrom = 567;
int ECGridIDTo = 4844;
ECGridService.ParcelIDInfoCollection ParcelInboxResults = ECGrid.ParcelInBoxEx(SessionID, NetworkID, MailboxID, ECGridIDFrom, ECGridIDTo);
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()); }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/ParcelInBoxEx"
<?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>
<ParcelInBoxEx xmlns="https://os.ecgrid.io/">
<SessionID>string</SessionID>
<NetworkID>int</NetworkID>
<MailboxID>int</MailboxID>
<ECGridIDFrom>int</ECGridIDFrom>
<ECGridIDTo>int</ECGridIDTo>
</ParcelInBoxEx>
</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>
<ParcelInBoxExResponse xmlns="https://os.ecgrid.io/">
<ParcelInBoxExResult>
<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>
</ParcelInBoxExResult>
</ParcelInBoxExResponse>
</soap:Body>
</soap:Envelope>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>
<ParcelInBoxEx xmlns="https://os.ecgrid.io/">
<SessionID>string</SessionID>
<NetworkID>int</NetworkID>
<MailboxID>int</MailboxID>
<ECGridIDFrom>int</ECGridIDFrom>
<ECGridIDTo>int</ECGridIDTo>
</ParcelInBoxEx>
</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>
<ParcelInBoxExResponse xmlns="https://os.ecgrid.io/">
<ParcelInBoxExResult>
<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>
</ParcelInBoxExResult>
</ParcelInBoxExResponse>
</soap12:Body>
</soap12:Envelope>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/ParcelInBoxEx?SessionID=string&NetworkID=string&MailboxID=string&ECGridIDFrom=string&ECGridIDTo=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>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/ParcelInBoxEx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length
SessionID=string&NetworkID=string&MailboxID=string&ECGridIDFrom=string&ECGridIDTo=stringHTTP/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>