Skip to content

NetworkAdd

Jump to bottom
Greg Kolinski edited this page Sep 20, 2017 · 1 revision

Back To Common API Calls

Add a Network to ECGrid.

*** Requires NetOps authorization. ***

  public int NetworkAdd(string SessionID, 
                        int NetworkID, 
                        string Name, 
                        string Location, 
                        NetworkServiceType Type, 
                        NetworkRoutingType RoutingType, 
                        string Password, 
                        short RunDir, 
                        string Server)

Parameters:

Returns

NetworkID - The value assigned to a specific Network Record - Integer

Remarks

*** Requires NetOps authorization. ***

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 NetworkID = 4576347;
           string Name = "Network_Name";
           string Location = "Location";
           string Password = "PASSWORD";
           short RunDir = 2;
           string Server = "Server_Name";

           int NetworkAddResult = ECGrid.NetworkAdd(SessionID, NetworkID, Name, Location, ECGridService.NetworkServiceType.HUB, ECGridService.NetworkRoutingType.TradingPartnerPairs, Password, RunDir, Server);

        }
        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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/NetworkAdd"

<?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>
    <NetworkAdd xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <Name>string</Name>
      <Location>string</Location>
      <Type>SVC or VAN or MBX or NET or APP or HUB</Type>
      <RoutingType>Open or OpenWithSenderValidation or TradingPartnerPairs or MultiNetwork or ECGridOpen or ECGridTradingPartnerPairs</RoutingType>
      <Password>string</Password>
      <RunDir>short</RunDir>
      <Server>string</Server>
    </NetworkAdd>
  </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>
    <NetworkAddResponse xmlns="http://ecgridos.net/">
      <NetworkAddResult>int</NetworkAddResult>
    </NetworkAddResponse>
  </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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
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>
    <NetworkAdd xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <Name>string</Name>
      <Location>string</Location>
      <Type>SVC or VAN or MBX or NET or APP or HUB</Type>
      <RoutingType>Open or OpenWithSenderValidation or TradingPartnerPairs or MultiNetwork or ECGridOpen or ECGridTradingPartnerPairs</RoutingType>
      <Password>string</Password>
      <RunDir>short</RunDir>
      <Server>string</Server>
    </NetworkAdd>
  </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>
    <NetworkAddResponse xmlns="http://ecgridos.net/">
      <NetworkAddResult>int</NetworkAddResult>
    </NetworkAddResponse>
  </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 /v3.2/prod/ecgridos.asmx/NetworkAdd?SessionID=string&NetworkID=string&Name=string&Location=string&Type=string&RoutingType=string&Password=string&RunDir=string&Server=string HTTP/1.1
Host: ecgridos.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://ecgridos.net/">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 /v3.2/prod/ecgridos.asmx/NetworkAdd HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&Name=string&Location=string&Type=string&RoutingType=string&Password=string&RunDir=string&Server=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="http://ecgridos.net/">int</int>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally