MailboxX12Delimiters - LorenData/ECGrid-API GitHub Wiki

Back To Common API Calls

Update a Mailbox override values for Segment Terminator, Element Separator and Subelement Separator.

  public boolean MailboxX12Delimiters(string SessionID,
                                      int MailboxID,
                                      unsignedByte SegTerm,
                                      unsignedByte ElmSep,
                                      unsignedByte SubElmSep)

Parameters

Returns

boolean

Remarks

ECGrid has the ability to normalize X12 delimiters for all inbound Parcels. By changing the value from zero (0) to any value 1 to 127, the matching ASCII character will be substituted for the specific delimiter.

By default, all values are set to zero (0) and no translation occurs.

Always leave these values as zero (0) if you plan to transfer non-EDI data over ECGrid. These values will have no effect on EDIFACT interchanges.

This has no affect on outbound Parcels.

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 MailboxID = 4576347;
            byte SegTerm = Convert.ToByte('~');
            byte ElmSep = Convert.ToByte("2A", 16); // Hex value from Base 16 number
            byte SubElmSep = Convert.ToByte(0x07); //Hex Representation of BEL or (bell)

            bool MailboxX12DelimitersResult = ECGrid.MailboxX12Delimiters(SessionID, MailboxID, SegTerm,ElmSep,SubElmSep);

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

<?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>
    <MailboxX12Delimiters xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <MailboxID>int</MailboxID>
      <SegTerm>unsignedByte</SegTerm>
      <ElmSep>unsignedByte</ElmSep>
      <SubElmSep>unsignedByte</SubElmSep>
    </MailboxX12Delimiters>
  </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>
    <MailboxX12DelimitersResponse xmlns="https://os.ecgrid.io/">
      <MailboxX12DelimitersResult>boolean</MailboxX12DelimitersResult>
    </MailboxX12DelimitersResponse>
  </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>
    <MailboxX12Delimiters xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <MailboxID>int</MailboxID>
      <SegTerm>unsignedByte</SegTerm>
      <ElmSep>unsignedByte</ElmSep>
      <SubElmSep>unsignedByte</SubElmSep>
    </MailboxX12Delimiters>
  </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>
    <MailboxX12DelimitersResponse xmlns="https://os.ecgrid.io/">
      <MailboxX12DelimitersResult>boolean</MailboxX12DelimitersResult>
    </MailboxX12DelimitersResponse>
  </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/MailboxX12Delimiters?SessionID=string&MailboxID=string&SegTerm=string&ElmSep=string&SubElmSep=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/MailboxX12Delimiters HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&MailboxID=string&SegTerm=string&ElmSep=string&SubElmSep=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

⚠️ **GitHub.com Fallback** ⚠️