General Read

pixiGetClientVersion

Returns the latest version and the minimum allowed version of one or all Pixi client applications.

Reads the version information of Pixi client applications from the table ExeClientVersion.

If Client is omitted, NULL or an empty string, one row per client stored in the table is returned.
If Client is given, only the row whose ClientName equals the given value is returned. If no client with that name exists, the result set is empty.

No sort order is applied.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible. The comparison on ClientName follows the collation of the database (usually case-insensitive). The column types are not visible in the code; the values are presumably version strings.

Parameters

Parameter	Type	Default	Description
`Client`	varchar(64) string	NULL	Name of the client application. Empty string or `NULL` returns all clients. Example: `PixiClient`

Response

Result set 1 · Always; all clients if `Client` is empty or NULL, otherwise only the matching client.

Version information per client application.

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

Response example

<SqlRowSet1>
  <row>
    <ClientName>PixiClient</ClientName>
    <LatestVersion>24.10.1</LatestVersion>
    <MinAllowedVersion>24.04.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:pixiGetClientVersion>
      <!-- <Client>PixiClient</Client> -->
    </ns1:pixiGetClientVersion>
  </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:pixiGetClientVersion>
      <!-- <Client>PixiClient</Client> -->
    </ns1:pixiGetClientVersion>
  </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 = [
    // 'Client' => 'PixiClient',
];

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

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

Tables used

ExeClientVersion · Read

SQL object:: dbo.pipiGetClientVersion