ParcelUpload

Upload an X12, EDIFACT, Tradacoms or VDA Parcel to the OutBox with Base64Array.

  public int ParcelUpload(string SessionID,
                          string FileName,
                          int Bytes,
                          base64Binary Content)

Parameters

SessionID - String - GUID
FileName - String
Bytes - Integer
Content - Byte[] (Base64)

Returns

int

Remarks

This method allows Parcels to be directly uploaded to ECGrid through the ECGridOS interface. Other communication channels are available such as FTP or AS2.

The content must be X12 or EDIFACT in order to be processed and routed by ECGrid. To send non-EDI data, use ParcelUploadDirected().

FileName must be a valid Windows filename, invalid FileNames will generate SOAP Exception.

Bytes must equal the Content length, or a SOAP Exception will be raised.

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";
            string FilePath = @"C:\EDI\X12_810.edi";
            FileInfo X12FileInfo = new FileInfo(FilePath);
            string FileName = X12FileInfo.Name;

            byte[] ContentFromFile = File.ReadAllBytes(FilePath);

            // or using Streams

            using (FileStream fs = new FileStream(FilePath,FileMode.Open))
            {
                using (var memoryStream = new MemoryStream())
                {
                    fs.CopyTo(memoryStream);
                    ContentFromFile = memoryStream.ToArray();
                }
            }

            /* .Net will Auto Convert byte[] to Base64 on Transport. 
               Below is the explicit Conversion for your reference

               string Base64FileString = Convert.ToBase64String(ContentFromFile);
               byte[] ContentBase64EncodedBytes = Convert.FromBase64String(Base64FileString);
            */

            int ParcelID = ECGrid.ParcelUpload(SessionID, FileName, ContentFromFile.Length, ContentFromFile);
                       
        }
        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/ParcelUpload"

<?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>
    <ParcelUpload xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <FileName>string</FileName>
      <Bytes>int</Bytes>
      <Content>base64Binary</Content>
    </ParcelUpload>
  </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>
    <ParcelUploadResponse xmlns="https://os.ecgrid.io/">
      <ParcelUploadResult>int</ParcelUploadResult>
    </ParcelUploadResponse>
  </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>
    <ParcelUpload xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <FileName>string</FileName>
      <Bytes>int</Bytes>
      <Content>base64Binary</Content>
    </ParcelUpload>
  </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>
    <ParcelUploadResponse xmlns="https://os.ecgrid.io/">
      <ParcelUploadResult>int</ParcelUploadResult>
    </ParcelUploadResponse>
  </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/ParcelUpload?SessionID=string&FileName=string&Bytes=string&Content=string&Content=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"?>
<int xmlns="https://os.ecgrid.io/">int</int>

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

SessionID=string&FileName=string&Bytes=string&Content=string&Content=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="https://os.ecgrid.io/">int</int>