Version

Returns the current version string of the ECGridOS SOAP API service.

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

Method Signature

string Version()

Parameters

This method takes no parameters. No SessionID is required — it can be called without authenticating first.

Response

Returns a string containing the API version (e.g., "4.1").

<!-- Example response -->
<VersionResponse xmlns="http://www.ecgridos.net/">
  <VersionResult>4.1</VersionResult>
</VersionResponse>

Code Examples

C#

// .NET 10 — dotnet-svcutil generated proxy
// No session required — safe to call before Login()
using var client = new ECGridOSClient(binding, endpoint);

string apiVersion = await client.VersionAsync();

Console.WriteLine($"ECGridOS SOAP API version: {apiVersion}");

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

:::tip Health check Version() is useful as a lightweight connectivity check. If it returns successfully, the service endpoint is reachable and responding. No credentials are required, so it can be called during application startup diagnostics. :::

REST Equivalent

See Version — GET /v2/auth/version.