TPSearch

Searches the ECGrid network directory for trading partner IDs matching the given ISA qualifier and ID value.

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

Method Signature

ArrayOfECGridIDInfo TPSearch(string SessionID, string Qualifier, string ID)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token obtained from Login()
Qualifier	string	Yes	ISA qualifier to search for (e.g., 01, 08, ZZ)
ID	string	Yes	ISA ID value to search for; supports partial/wildcard matching

Response Object — ArrayOfECGridIDInfo

Returns an array of matching ECGridIDInfo objects. See ECGridIDInfo for field definitions.

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

<!-- Example response XML -->
<TPSearchResult>
  <ECGridIDInfo>
    <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>
  </ECGridIDInfo>
</TPSearchResult>

Variants

TPSearchEx

Extends TPSearch by scoping the search to a specific network and mailbox, allowing operators to find IDs within their own managed environment.

ArrayOfECGridIDInfo TPSearchEx(string SessionID, int NetworkID, int MailboxID, string Qualifier, string ID)

Additional Parameter	Type	Description
NetworkID	int	Scope search to this network; use 0 for all accessible networks
MailboxID	int	Scope search to this mailbox; use 0 for all mailboxes

Code Examples

C#

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

// Search across all accessible networks
ECGridIDInfo[] results = await client.TPSearchAsync(
    sessionID,
    qualifier: "01",
    id: "ACMECORP");

foreach (var match in results)
{
    Console.WriteLine($"ECGridID: {match.ECGridID}  {match.Qualifier}:{match.ID}  {match.Description}");
}

// Scoped search using TPSearchEx
ECGridIDInfo[] scopedResults = await client.TPSearchExAsync(
    sessionID,
    networkID: 42,
    mailboxID: 0,    // all mailboxes in network 42
    qualifier: "ZZ",
    id: "PARTNER");

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

REST Equivalent

See Find ID — POST /v2/ids/find.