General Read

pixiGetVersions

Returns the latest and minimum allowed executable versions of Pixi client applications, optionally for one client name.

Reads the version information of client executables from the table ExeClientVersion.

If ClientName is omitted or NULL, all rows of the table are returned.
If ClientName is given, only the row(s) whose ClientName matches the value exactly are returned.

Each row contains the client name, the latest available version and the minimum version a client must have to be allowed to run. No explicit sort order is applied.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible.
The result has no ORDER BY; the row order is not guaranteed.
An unknown ClientName returns an empty result set, not an error.
The data types of the columns are not visible in the code; they come from the table ExeClientVersion.

Parameters

Parameter	Type	Default	Description
`ClientName`	varchar(50) string	NULL	Name of the client application to filter by (exact match). `NULL` returns all clients. Example: `PixiClient`

Response

Result set 1 · Always (empty if no matching row exists)

Version information per client application.

Column	Type	Description
`ClientName`	string	Name of the client application.
`LatestVersion` Nullable	string	Latest available version of the client executable.
`MinAllowedVersion` Nullable	string	Minimum version of the client executable that is still allowed.

Response example

<SqlRowSet1>
  <row>
    <ClientName>PixiClient</ClientName>
    <LatestVersion>24.3.1.0</LatestVersion>
    <MinAllowedVersion>23.11.0.0</MinAllowedVersion>
  </row>
</SqlRowSet1>

Examples

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetVersions>
      <!-- <ClientName>PixiClient</ClientName> -->
    </ns1:pixiGetVersions>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetVersions>
      <!-- <ClientName>PixiClient</ClientName> -->
    </ns1:pixiGetVersions>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'ClientName' => 'PixiClient',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetVersions', $soapArguments);

Tables used

ExeClientVersion · Read

SQL object:: dbo.pipiGetVersions