pixiGetCurrentPixiVersion · Pixi API documentation

The call takes no parameters. It forwards directly to the internal procedure Pixi_GetCurrentPixiVersion and returns one row.

Steps:

The version information is read through Pixi_GetCurrentVersion. This yields the version from the local change log (DB_Change_Log) and from the master database.
The endpoint data of the client is read from the master database through util.Master_EndpointGet. This includes the default entry point URI, the client ID and the internal version name.
The column InformationQualityDescription is set:
- 200 OK: the master database was reachable and its version matches the local change log.
- 401 ...: the master database was reachable, but its version differs from the local DB_Change_Log.
- 301 ...: the master database could not be accessed. The information comes from the local change log only.
A trailing slash is appended to DefaultEntryPointUri if it is missing.

Version selection:

Version and RevisionName use the values from the local change log.
If those are NULL, the master values are used instead.

The row also contains:

the database name
the setting DesktopLoginEnabled (defaults to 1 if not set)

Notes

The objects Pixi_GetCurrentVersion, util.Master_EndpointGet and dbo.SettingGet are not attached. Which tables they read, and when the master endpoint returns a status other than 200, cannot be seen from the code.
If Pixi_GetCurrentVersion returns no row, the call returns an empty result set.
If the local change log version is NULL, the comparison with the master version is not true. In that case the status stays 200 OK even though nothing was compared.
If the master database is not reachable, Version_Master, DefaultEntryPointUri and ClientId can be NULL. A NULL DefaultEntryPointUri stays NULL; no slash is appended.
The information quality is returned as a text column, not as an SQL error. The leading number (200, 301, 401) can be evaluated.

This call has no parameters.

Result set 1 · Always (one row, empty if no version information exists)

Version and endpoint information of the current Pixi database.

Column	Type	Description
`Version` Nullable	varchar(100) string	Internal version name from the local change log, or from the master database if the local value is missing.
`RevisionName` Nullable	varchar(1024) string	Revision name from the local change log, or from the master database if the local value is missing.
`InformationQualityDescription` Nullable	varchar(150) string	Quality of the version information: `200 OK`, `301 ...` (master not reachable) or `401 ...` (master and local version differ).
`Version_DbChangeLog` Nullable	varchar(100) string	Version name from the local `DB_Change_Log`.
`Version_Master` Nullable	varchar(150) string	Internal version name from the master database endpoint entry.
`DatabaseName` Nullable	varchar(150) string	Name of the current database.
`IsDesktopLoginEnabled`	string	Value of the setting `DesktopLoginEnabled`; `1` if the setting is not set.
`DefaultEntryPointUri` Nullable	varchar(150) string	Default entry point URI from the master database, always ending with `/` unless it is NULL.
`ClientId` Nullable	varchar(150) string	Client ID from the master database.

Response example

<SqlRowSet1>
  <row>
    <Version>24.10.1</Version>
    <RevisionName>Release 24.10 Build 1</RevisionName>
    <InformationQualityDescription>200 OK</InformationQualityDescription>
    <Version_DbChangeLog>24.10.1</Version_DbChangeLog>
    <Version_Master>24.10.1</Version_Master>
    <DatabaseName>PIXI_SHOP01</DatabaseName>
    <IsDesktopLoginEnabled>1</IsDesktopLoginEnabled>
    <DefaultEntryPointUri>https://shop01.pixi.example.com/</DefaultEntryPointUri>
    <ClientId>SHOP01</ClientId>
  </row>
</SqlRowSet1>

Status	Message	Cause
301	301 Master database cannot be accessed, information is from local DB_Change_log	Returned in column `InformationQualityDescription` when the master endpoint lookup does not return status 200. The version is taken from the local change log only.
401	401 Master database's entry version information is not consistent with local DB_Change_Log	Returned in column `InformationQualityDescription` when the master database's version name differs from the version in the local `DB_Change_Log`.

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:pixiGetCurrentPixiVersion/>
  </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:pixiGetCurrentPixiVersion/>
  </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 = [
];

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

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