Orderlines Lesen

pixiGetText

Liefert den Klartext zu einem Objektcode; derzeit wird nur der Status von Auftragspositionen (`ORDERLINE_STATUS`) unterstützt.

Skalarfunktion, die einen Code in den zugehörigen Text übersetzt.

Ist ObjectType gleich ORDERLINE_STATUS (ohne Beachtung der Groß-/Kleinschreibung, Vergleich über UPPER), wird in OrderStates die Zeile gesucht, deren State dem Wert von ObjectId entspricht, und deren StateText zurückgegeben.
Bei jedem anderen ObjectType oder wenn kein passender Status existiert, liefert die Funktion NULL.

Das Ergebnis ist ein einzelner Wert vom Typ varchar(1024).

Hinweise

Die Abfrage verwendet NOLOCK, daher können nicht festgeschriebene Daten gelesen werden.
ObjectId wird als varchar(100) übergeben und mit State verglichen; eine implizite Konvertierung hängt vom Spaltentyp von State ab, der im Code nicht sichtbar ist.
Treffen mehrere Zeilen zu, wird der Wert der zuletzt gelesenen Zeile zurückgegeben (Variablenzuweisung im SELECT).

Parameter

Parameter Typ Standardwert Beschreibung

Parameter	Typ	Standardwert	Beschreibung
`ObjectType` Pflicht	varchar(100) string	–	Art des Objekts, dessen Text abgefragt wird. Vergleich ohne Beachtung der Groß-/Kleinschreibung. Erlaubte Werte `ORDERLINE_STATUS` – Liefert `StateText` des Positionsstatus aus `OrderStates`. Beispiel: `ORDERLINE_STATUS`
`ObjectId` Pflicht	varchar(100) string	–	Code des Objekts, bei `ORDERLINE_STATUS` der Statuscode (`State`) der Auftragsposition. Beispiel: `AU`

ObjectType

Pflicht

varchar(100)
string

–

Art des Objekts, dessen Text abgefragt wird. Vergleich ohne Beachtung der Groß-/Kleinschreibung.

Erlaubte Werte

ORDERLINE_STATUS – Liefert `StateText` des Positionsstatus aus `OrderStates`.

Beispiel: ORDERLINE_STATUS

ObjectId

Pflicht

varchar(100)
string

–

Code des Objekts, bei ORDERLINE_STATUS der Statuscode (State) der Auftragsposition.

Beispiel: AU

Antwort

Result-Set 1 · Immer

Einzelner Rückgabewert der Skalarfunktion.

Spalte	Typ	Beschreibung
`Result` Kann leer sein	varchar(1024) string	Text des Status oder `NULL`, wenn die Objektart nicht unterstützt wird oder der Code unbekannt ist.

Beispielantwort

<SqlRowSet1>
  <row>
    <Result>Ausgeliefert</Result>
  </row>
</SqlRowSet1>

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:pixiGetText>
      <ObjectType>ORDERLINE_STATUS</ObjectType>
      <ObjectId>AU</ObjectId>
    </ns1:pixiGetText>
  </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:pixiGetText>
      <ObjectType>ORDERLINE_STATUS</ObjectType>
      <ObjectId>AU</ObjectId>
    </ns1:pixiGetText>
  </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 = [
    'ObjectType' => 'ORDERLINE_STATUS',
    'ObjectId' => 'AU',
];

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

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

Verwendete Tabellen

OrderStates · Lesen

SQL-Objekt:: dbo.pipiGetText