CommPair

Returns the communication channels that are active between two trading partners identified by their ECGrid IDs.

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

Method Signature

ArrayOfCommIDInfo CommPair(string SessionID, int ECGridIDFrom, int ECGridIDTo)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token from Login()
ECGridIDFrom	int	Yes	ECGrid ID of the sending trading partner
ECGridIDTo	int	Yes	ECGrid ID of the receiving trading partner

Response Object — ArrayOfCommIDInfo

Returns an array of CommIDInfo objects representing the comm channels connecting the two trading partners.

Field	Type	Description
CommID	int	Unique identifier of the comm channel
MailboxID	int	Mailbox associated with this comm channel
CommType	NetworkGatewayCommChannel	Protocol type
Identifier	string	Protocol-specific identifier
Status	Status	Current status of the comm channel
UseType	UseType	Test, production, or both
PrivateKeyRequired	bool	Whether a private key is required
WithCerts	bool	Whether certificate details are included

<!-- Example response XML -->
<ArrayOfCommIDInfo>
  <CommIDInfo>
    <CommID>4521</CommID>
    <MailboxID>100</MailboxID>
    <CommType>as2</CommType>
    <Identifier>PARTNER-AS2-ID</Identifier>
    <Status>Active</Status>
    <UseType>Production</UseType>
    <PrivateKeyRequired>true</PrivateKeyRequired>
    <WithCerts>false</WithCerts>
  </CommIDInfo>
</ArrayOfCommIDInfo>

Code Examples

C#

// .NET 10 — dotnet-svcutil generated proxy
using ECGridOSClient;

var client = new ECGridOSPortTypeClient();

// Find comm channels between two trading partners
CommIDInfo[] pair = await client.CommPairAsync(
    sessionID,
    ECGridIDFrom: 1234567,
    ECGridIDTo: 9876543);

foreach (var ch in pair)
{
    Console.WriteLine($"CommID: {ch.CommID} | Type: {ch.CommType} | Identifier: {ch.Identifier}");
}

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

REST Equivalent

See Comm Pair — POST /v2/comms/pair.