General Lesen

pixiGetCurrentPixiVersion

Liefert die Version der aktuellen Pixi-Datenbank, den Revisionsnamen, den Konsistenzstatus zur Master-Datenbank sowie Endpunkt-Informationen.

Der Aufruf hat keine Parameter. Er leitet direkt an die interne Prozedur Pixi_GetCurrentPixiVersion weiter und liefert eine Zeile.

Ablauf:

Die Versionsinformationen werden über Pixi_GetCurrentVersion gelesen. Dies liefert die Version aus dem lokalen Änderungsprotokoll (DB_Change_Log) und aus der Master-Datenbank.
Die Endpunktdaten des Mandanten werden über util.Master_EndpointGet aus der Master-Datenbank gelesen. Dazu gehören Standard-Einstiegs-URI, Client-ID und interner Versionsname.
Die Spalte InformationQualityDescription wird gesetzt:
- 200 OK: Die Master-Datenbank war erreichbar, und ihre Version stimmt mit dem lokalen Änderungsprotokoll überein.
- 401 ...: Die Master-Datenbank war erreichbar, ihre Version weicht aber vom lokalen DB_Change_Log ab.
- 301 ...: Auf die Master-Datenbank konnte nicht zugegriffen werden. Die Angaben stammen nur aus dem lokalen Änderungsprotokoll.
An DefaultEntryPointUri wird ein abschließender Schrägstrich angehängt, falls er fehlt.

Versionsauswahl:

Version und RevisionName verwenden die Werte aus dem lokalen Änderungsprotokoll.
Sind diese NULL, werden ersatzweise die Master-Werte verwendet.

Die Zeile enthält außerdem:

den Datenbanknamen
die Einstellung DesktopLoginEnabled (Standard 1, falls nicht gesetzt)

Hinweise

Die Objekte Pixi_GetCurrentVersion, util.Master_EndpointGet und dbo.SettingGet sind nicht beigefügt. Welche Tabellen sie lesen und wann der Master-Endpunkt einen anderen Status als 200 liefert, ist aus dem Code nicht ersichtlich.
Liefert Pixi_GetCurrentVersion keine Zeile, ist das Ergebnis leer.
Ist die Version aus dem lokalen Änderungsprotokoll NULL, ergibt der Vergleich mit der Master-Version nicht wahr. Der Status bleibt dann 200 OK, obwohl nichts verglichen wurde.
Ist die Master-Datenbank nicht erreichbar, können Version_Master, DefaultEntryPointUri und ClientId NULL sein. Ein NULL-Wert in DefaultEntryPointUri bleibt NULL; es wird kein Schrägstrich angehängt.
Die Informationsqualität wird als Textspalte geliefert, nicht als SQL-Fehler. Die führende Zahl (200, 301, 401) kann ausgewertet werden.

Parameter

Dieser Call hat keine Parameter.

Antwort

Result-Set 1 · Immer (eine Zeile, leer, falls keine Versionsinformationen vorhanden sind)

Versions- und Endpunktinformationen der aktuellen Pixi-Datenbank.

Spalte	Typ	Beschreibung
`Version` Kann leer sein	varchar(100) string	Interner Versionsname aus dem lokalen Änderungsprotokoll, ersatzweise aus der Master-Datenbank.
`RevisionName` Kann leer sein	varchar(1024) string	Revisionsname aus dem lokalen Änderungsprotokoll, ersatzweise aus der Master-Datenbank.
`InformationQualityDescription` Kann leer sein	varchar(150) string	Qualität der Versionsinformation: `200 OK`, `301 ...` (Master nicht erreichbar) oder `401 ...` (Master- und lokale Version weichen ab).
`Version_DbChangeLog` Kann leer sein	varchar(100) string	Versionsname aus dem lokalen `DB_Change_Log`.
`Version_Master` Kann leer sein	varchar(150) string	Interner Versionsname aus dem Endpunkteintrag der Master-Datenbank.
`DatabaseName` Kann leer sein	varchar(150) string	Name der aktuellen Datenbank.
`IsDesktopLoginEnabled`	string	Wert der Einstellung `DesktopLoginEnabled`; `1`, falls die Einstellung nicht gesetzt ist.
`DefaultEntryPointUri` Kann leer sein	varchar(150) string	Standard-Einstiegs-URI aus der Master-Datenbank, endet immer mit `/`, sofern nicht NULL.
`ClientId` Kann leer sein	varchar(150) string	Client-ID aus der Master-Datenbank.

Beispielantwort

<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>

Fehlermeldungen

Status	Meldung	Ursache
301	301 Master database cannot be accessed, information is from local DB_Change_log	Wird in der Spalte `InformationQualityDescription` geliefert, wenn die Abfrage des Master-Endpunkts nicht Status 200 zurückgibt. Die Version stammt dann nur aus dem lokalen Änderungsprotokoll.
401	401 Master database's entry version information is not consistent with local DB_Change_Log	Wird in der Spalte `InformationQualityDescription` geliefert, wenn der Versionsname der Master-Datenbank von der Version im lokalen `DB_Change_Log` abweicht.

Beispiele

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);

SQL-Objekt:: dbo.pipiGetCurrentPixiVersion