General Lesen

pixiImportFindXML

Liefert den neuesten XML-Importlog-Eintrag zu einem Auftrag (über ORDER_ID) oder einem Artikel (über SUPPLIER_AID).

Durchsucht das XML-Importlog C_XMLLog nach dem neuesten Eintrag, der eine angegebene ID enthält, und liefert ihn mit Request-, Response- und Statusinformationen.

Ist Id leer oder NULL, wird eine Statuszeile mit StatusCode 400 zurückgegeben; weitere Schritte erfolgen nicht.
Type wird ohne Beachtung der Groß-/Kleinschreibung ausgewertet:
- order: Ermittelt den Operationstyp OrderImport aus C_OperationTypes und sucht Logeinträge, deren XmlResponseXml ein Element ORDER_ID (in beliebiger Tiefe) mit dem Wert von Id enthält.
- item: Ermittelt den Operationstyp ItemImport und sucht nach einem Element SUPPLIER_AID (in beliebiger Tiefe) mit dem Wert von Id.
- Jeder andere Wert liefert eine Statuszeile mit StatusCode 400.
Zusätzliche Filter für beide Typen:
- Ist Channel angegeben, werden nur Einträge mit dieser ChannelRef berücksichtigt; bei NULL werden alle Kanäle durchsucht.
- Einträge mit Status = XNI werden ausgeschlossen.
Das Ergebnis wird absteigend nach XMLLogKey sortiert, und nur die erste Zeile (der neueste passende Logeintrag) wird geliefert. Gibt es keinen Treffer, ist die Ergebnismenge leer.

Hinweise

Alle Lesezugriffe verwenden NOLOCK; nicht festgeschriebene Logeinträge können daher geliefert werden.
Der ID-Vergleich ist ein exakter Zeichenkettenvergleich mit dem Elementwert in XmlResponseXml per XPath-exist() mit Nachfahrensuche (//). Dies wird für jede in Frage kommende Logzeile ausgewertet und kann bei großen Logtabellen langsam sein; die Angabe von Channel schränkt die Suche ein.
Die Prüfung von Id erfolgt vor der Prüfung von Type; bei leerer Id wird daher immer die ID-Fehlermeldung geliefert, auch wenn Type ungültig ist.
Existiert der Operationstyp OrderImport bzw. ItemImport nicht in C_OperationTypes, werden keine Zeilen geliefert.
Die Bedeutung des Statuswerts XNI ist im Code nicht definiert.
Response ist die XML-Spalte XmlResponseXml, konvertiert nach varchar(max).

Parameter

Parameter Typ Standardwert Beschreibung

Parameter	Typ	Standardwert	Beschreibung
`Type` Pflicht	varchar(10) string	–	Art des Imports, in dem gesucht wird (ohne Beachtung der Groß-/Kleinschreibung). Erlaubte Werte `order` – Sucht in Auftragsimporten (`OrderImport`) über `ORDER_ID`. `item` – Sucht in Artikelimporten (`ItemImport`) über `SUPPLIER_AID`. Beispiel: `order`
`Id` Pflicht	varchar(50) string	–	Gesuchter Wert: die Auftrags-ID (`ORDER_ID`) bei `order` bzw. die Lieferantenartikelnummer (`SUPPLIER_AID`) bei `item`. Darf nicht leer sein. Beispiel: `100004711`
`Channel`	int	NULL	Optionaler Kanalschlüssel (`ChannelRef`) zur Einschränkung der Suche; `NULL` durchsucht alle Kanäle. Beispiel: `3`

Type

Pflicht

varchar(10)
string

–

Art des Imports, in dem gesucht wird (ohne Beachtung der Groß-/Kleinschreibung).

Erlaubte Werte

order – Sucht in Auftragsimporten (`OrderImport`) über `ORDER_ID`.
item – Sucht in Artikelimporten (`ItemImport`) über `SUPPLIER_AID`.

Beispiel: order

Id

Pflicht

varchar(50)
string

–

Gesuchter Wert: die Auftrags-ID (ORDER_ID) bei order bzw. die Lieferantenartikelnummer (SUPPLIER_AID) bei item. Darf nicht leer sein.

Beispiel: 100004711

Channel

int

NULL

Optionaler Kanalschlüssel (ChannelRef) zur Einschränkung der Suche; NULL durchsucht alle Kanäle.

Beispiel: 3

Antwort

Result-Set 1 · Wenn `Id` leer oder `NULL` ist oder `Type` weder `order` noch `item` ist

Statuszeile mit der Beschreibung des Validierungsfehlers.

Spalte	Typ	Beschreibung
`StatusCode`	int	Immer 400.
`StatusMessage`	varchar(55) string	Fehlertext.

Result-Set 2 · Wenn `Id` gesetzt ist und `Type` `order` oder `item` ist; null oder eine Zeile

Der neueste passende XML-Importlog-Eintrag.

Spalte	Typ	Beschreibung
`XMLLogKey`	int	Schlüssel des Logeintrags in `C_XMLLog`.
`Request` Kann leer sein	string	Ursprünglicher Import-Request (`XMLRequest`).
`Response` Kann leer sein	varchar(max) string	Inhalt von `XmlResponseXml`, in Text konvertiert.
`Status` Kann leer sein	string	Verarbeitungsstatus des Logeintrags (nie `XNI`).
`CreateDate` Kann leer sein	dateTime	Erstellungszeitpunkt des Logeintrags.
`UpdateDate` Kann leer sein	dateTime	Zeitpunkt der letzten Änderung des Logeintrags.
`Error` Kann leer sein	string	Zum Import gespeicherte Fehlerinformation.
`XmlResponseCastErrorNr` Kann leer sein	int	Fehlernummer bei der Konvertierung der Response in XML, falls vorhanden.
`XmlResponseCastErrorMessage` Kann leer sein	string	Fehlermeldung bei der Konvertierung der Response in XML, falls vorhanden.

Beispielantwort

<SqlRowSet1>
  <row>
    <XMLLogKey>58231</XMLLogKey>
    <Request>&lt;ORDER&gt;...&lt;/ORDER&gt;</Request>
    <Response>&lt;ORDER&gt;&lt;ORDER_HEADER&gt;&lt;ORDER_INFO&gt;&lt;ORDER_ID&gt;100004711&lt;/ORDER_ID&gt;&lt;/ORDER_INFO&gt;&lt;/ORDER_HEADER&gt;&lt;/ORDER&gt;</Response>
    <Status>OK</Status>
    <CreateDate>2024-03-12T10:15:22</CreateDate>
    <UpdateDate>2024-03-12T10:15:25</UpdateDate>
    <Error/>
    <XmlResponseCastErrorNr>0</XmlResponseCastErrorNr>
    <XmlResponseCastErrorMessage/>
  </row>
</SqlRowSet1>

Fehlermeldungen

Status	Meldung	Ursache
400	You have to specify an ID to search for	`Id` ist leer oder `NULL`. Eine nicht leere Auftrags-ID bzw. Lieferantenartikelnummer übergeben.
400	You have to specify XML type (either "order" or "item")	`Type` ist weder `order` noch `item`. Einen dieser beiden Werte übergeben.

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:pixiImportFindXML>
      <Type>order</Type>
      <Id>100004711</Id>
      <!-- <Channel>3</Channel> -->
    </ns1:pixiImportFindXML>
  </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:pixiImportFindXML>
      <Type>order</Type>
      <Id>100004711</Id>
      <!-- <Channel>3</Channel> -->
    </ns1:pixiImportFindXML>
  </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 = [
    'Type' => 'order',
    'Id' => '100004711',
    // 'Channel' => '3',
];

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

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

Verwendete Tabellen

C_OperationTypes · Lesen C_XMLLog · Lesen

SQL-Objekt:: dbo.pipiImportFindXML