TPAddVAN

Associates a VAN (Value Added Network) qualifier and ID with an existing ECGrid trading partner ID to enable cross-network routing.

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

Method Signature

ECGridIDInfo TPAddVAN(string SessionID, int ECGridID, string VANQualifier, string VANID)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token obtained from Login()
ECGridID	int	Yes	Numeric ECGrid identifier for the trading partner ID to update
VANQualifier	string	Yes	ISA qualifier used by the VAN for this trading partner
VANID	string	Yes	ISA ID value used by the VAN for this trading partner

Response Object — ECGridIDInfo

Returns the updated ECGridIDInfo object confirming the VAN association.

Field	Type	Description
ECGridID	int	Unique numeric identifier
MailboxID	int	Owning mailbox ID
NetworkID	int	Associated network ID
Qualifier	string	ECGrid ISA qualifier
ID	string	ECGrid ISA ID value
Description	string	Trading partner label
Status	Status	Lifecycle status
RoutingGroup	RoutingGroup	Routing group
EDIStandard	EDIStandard	EDI standard

<!-- Example response XML -->
<TPAddVANResult>
  <ECGridID>123456</ECGridID>
  <MailboxID>789</MailboxID>
  <NetworkID>42</NetworkID>
  <Qualifier>01</Qualifier>
  <ID>ACMECORP      </ID>
  <Description>Acme Corporation</Description>
  <Status>Active</Status>
  <RoutingGroup>ProductionA</RoutingGroup>
  <EDIStandard>X12</EDIStandard>
</TPAddVANResult>

note

VAN cross-referencing allows ECGrid to route inbound EDI that arrives using a VAN's qualifier/ID pair to the correct ECGrid mailbox. This is commonly used when a trading partner is reachable through multiple networks.

Code Examples

C#

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

// Associate VAN identifier "08:VANPARTNER01" with ECGridID 123456
ECGridIDInfo updated = await client.TPAddVANAsync(
    sessionID,
    ecGridID: 123456,
    vanQualifier: "08",
    vanID: "VANPARTNER01");

Console.WriteLine($"VAN association added for ECGridID {updated.ECGridID}");

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

REST Equivalent

See Add VAN — POST /v2/ids/tp-add-van.