InterconnectCancel

Permanently terminates a trading partner interconnect, preventing further EDI traffic between the two parties.

:::caution Established API The SOAP API is in maintenance mode. For new integrations use the REST equivalent. :::

Method Signature

bool InterconnectCancel(string SessionID, int InterconnectID)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token obtained from Login()
InterconnectID	int	Yes	Numeric identifier for the interconnect to cancel

Response

Returns true if the interconnect was successfully terminated; false otherwise.

<!-- Example response XML -->
<InterconnectCancelResult>true</InterconnectCancelResult>

caution

Cancelling an interconnect is a permanent action. Once cancelled, EDI traffic can no longer flow between the two ECGrid IDs on this interconnect. A new interconnect must be created with InterconnectAdd to restore routing.

To temporarily halt traffic, use InterconnectUpdate with Status.Suspended instead.

Code Examples

C#

// .NET 10 — dotnet-svcutil generated proxy
using var client = new ECGridOSPortTypeClient();

bool cancelled = await client.InterconnectCancelAsync(sessionID, 5001);

if (cancelled)
{
    Console.WriteLine("Interconnect 5001 has been permanently terminated.");
}
else
{
    Console.WriteLine("Cancellation failed — verify InterconnectID and permissions.");
}

Java

// JAX-WS generated client
// wsimport -s src https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL

ECGridOS service = new ECGridOS();
ECGridOSPortType port = service.getECGridOSPort();

var result = port.InterconnectCancel(sessionID /*, additional params */);
System.out.println(result);

Node.js

// npm install soap
import soap from 'soap';

const WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL';
const client = await soap.createClientAsync(WSDL);

const [result] = await client.InterconnectCancelAsync({
  SessionID: sessionId,
  // additional params
});
console.log(result);

Python

# pip install zeep
from zeep import Client

WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL'
client = Client(WSDL)

result = client.service.InterconnectCancel(
    SessionID=session_id,
    # additional params
)
print(result)

REST Equivalent

See Delete Partner — DELETE /v2/partners/{id}.