Add VAN

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

Endpoint

POST /v2/ids/tp-add-van

Request Body

Field	Type	Required	Constraints	Description
ecGridId	integer	Yes	Must be a valid ECGrid ID	The ECGrid ID to associate the VAN entry with
vanQualifier	string	Yes	ISA qualifier code used by the VAN	VAN-side ISA qualifier
vanId	string	Yes	ISA ID used by the VAN	VAN-side ISA identifier

{
  "ecGridId": 123456,
  "vanQualifier": "01",
  "vanId": "VANPARTNER001"
}

Response

Returns a success boolean confirming the VAN association was added.

{
  "success": true,
  "data": true
}

Code Examples

cURL

curl -X POST "https://rest.ecgrid.io/v2/ids/tp-add-van" \
  -H "X-API-Key: $ECGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "ecGridId": 123456, "vanQualifier": "01", "vanId": "VANPARTNER001" }'

C#

// .NET 10 — add a VAN qualifier/ID mapping to an ECGrid ID for cross-network routing
using var client = httpClientFactory.CreateClient("ECGrid");

var request = new
{
    ecGridId = 123456,
    vanQualifier = "01",
    vanId = "VANPARTNER001"
};

var response = await client.PostAsJsonAsync(
    "https://rest.ecgrid.io/v2/ids/tp-add-van", request);
response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<bool>>();
Console.WriteLine($"VAN association added: {result!.Data}");

Java

import java.net.URI;
import java.net.http.*;

String apiKey = System.getenv("ECGRID_API_KEY");

String body = "{ \"ecGridId\": 123456, \"vanQualifier\": \"01\", \"vanId\": \"VANPARTNER001\" }";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://rest.ecgrid.io/v2/ids/tp-add-van"))
    .header("X-API-Key", apiKey)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Node.js

const apiKey = process.env.ECGRID_API_KEY;
const url = 'https://rest.ecgrid.io/v2/ids/tp-add-van';

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ "ecGridId": 123456, "vanQualifier": "01", "vanId": "VANPARTNER001" }),
});

const data = await response.json();
console.log(data);

Python

import os, requests

api_key = os.environ["ECGRID_API_KEY"]
headers = {"X-API-Key": api_key}
url = "https://rest.ecgrid.io/v2/ids/tp-add-van"

response = requests.post(
    url,
    json={ "ecGridId": 123456, "vanQualifier": "01", "vanId": "VANPARTNER001" },
    headers=headers,
)

response.raise_for_status()
print(response.json())

See Also

• Get ID
• Create ID
• Create Partner (Interconnect)