InterconnectInfo

Returns detailed information about a single trading partner interconnect by its numeric identifier.

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

Method Signature

InterconnectIDInfo InterconnectInfo(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 record

Response Object — InterconnectIDInfo

Field	Type	Description
InterconnectID	int	Unique numeric identifier for this interconnect
ECGridIDFrom	int	ECGrid ID of the sending trading partner
ECGridIDTo	int	ECGrid ID of the receiving trading partner
Status	Status	Current lifecycle status of the interconnect
Created	datetime	Timestamp when the interconnect was established
Modified	datetime	Timestamp of the last modification

<!-- Example response XML -->
<InterconnectInfoResult>
  <InterconnectID>5001</InterconnectID>
  <ECGridIDFrom>123456</ECGridIDFrom>
  <ECGridIDTo>234567</ECGridIDTo>
  <Status>Active</Status>
  <Created>2024-01-15T10:30:00</Created>
  <Modified>2024-06-01T08:00:00</Modified>
</InterconnectInfoResult>

ENUMs

Status

Value	Description
Development	Interconnect is being configured
Active	Interconnect is live; EDI traffic can flow
Preproduction	Interconnect is staged for production
Suspended	Interconnect is temporarily halted
Terminated	Interconnect has been permanently closed

Code Examples

C#

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

InterconnectIDInfo info = await client.InterconnectInfoAsync(sessionID, 5001);

Console.WriteLine($"Interconnect {info.InterconnectID}: {info.ECGridIDFrom} → {info.ECGridIDTo}");
Console.WriteLine($"Status: {info.Status}  Created: {info.Created:yyyy-MM-dd}");

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.InterconnectInfo(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.InterconnectInfoAsync({
  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.InterconnectInfo(
    SessionID=session_id,
    # additional params
)
print(result)

REST Equivalent

See Get Partner — GET /v2/partners/{id}.