Items Lesen

pixiGetCategories

Liefert die Artikelkategorien (Tabelle TontrArten), optional gefiltert nach Schlüssel, Kurzbezeichnung oder Text.

Liest die Kategorie-Stammdaten aus TontrArten und liefert Schlüssel, Kurzbezeichnung und Bezeichnung jeder Kategorie.

Leere Werte werden zuerst normalisiert: TontrArtKey = 0 sowie leere Zeichenketten für TontrShort oder TontrText werden als NULL behandelt.

Es wird immer nur ein Filter angewendet, in folgender Rangfolge:

Ist TontrArtKey gesetzt, wird nur die Kategorie mit diesem Schlüssel geliefert.
Andernfalls, wenn TontrShort gesetzt ist, werden Kategorien mit exakt passender Kurzbezeichnung geliefert.
Andernfalls, wenn TontrText gesetzt ist, werden Kategorien mit exakt passendem Text geliefert.
Ist kein Parameter gesetzt, werden alle Kategorien geliefert.

Das Ergebnis ist stets aufsteigend nach TontrText sortiert.

Hinweise

Filter werden nicht kombiniert: Werden mehrere Parameter übergeben, gilt nur der mit der höchsten Priorität (TontrArtKey > TontrShort > TontrText); die übrigen werden ignoriert.
Der Vergleich ist exakt (=), ohne Platzhalter oder Teilsuche.
Die Tabelle wird mit WITH (NOLOCK) gelesen, daher können nicht festgeschriebene Änderungen sichtbar sein.
Gibt es keinen Treffer, wird eine leere Ergebnismenge geliefert; eine Fehlerzeile gibt es nicht.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`TontrArtKey`	int	NULL	Schlüssel der Kategorie. `0` wird als `NULL` behandelt. Hat die höchste Filterpriorität. Beispiel: `3`
`TontrShort`	varchar(50) string	NULL	Kurzbezeichnung der Kategorie (exakter Vergleich). Leere Zeichenkette wird als `NULL` behandelt. Wird nur verwendet, wenn `TontrArtKey` nicht gesetzt ist. Beispiel: `BOOK`
`TontrText`	varchar(50) string	NULL	Bezeichnung der Kategorie (exakter Vergleich). Leere Zeichenkette wird als `NULL` behandelt. Wird nur verwendet, wenn weder `TontrArtKey` noch `TontrShort` gesetzt ist. Beispiel: `Books`

Antwort

Result-Set 1 · Immer (kann leer sein, wenn keine Kategorie passt).

Passende Kategorien, aufsteigend sortiert nach TontrText.

Spalte	Typ	Beschreibung
`TontrArtKey`	int	Schlüssel der Kategorie.
`TontrShort` Kann leer sein	varchar(50) string	Kurzbezeichnung der Kategorie.
`TontrText` Kann leer sein	varchar(50) string	Bezeichnung der Kategorie.

Beispielantwort

<SqlRowSet1>
  <row>
    <TontrArtKey>3</TontrArtKey>
    <TontrShort>BOOK</TontrShort>
    <TontrText>Books</TontrText>
  </row>
  <row>
    <TontrArtKey>5</TontrArtKey>
    <TontrShort>CD</TontrShort>
    <TontrText>Music CDs</TontrText>
  </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:pixiGetCategories>
      <!-- <TontrArtKey>3</TontrArtKey> -->
      <!-- <TontrShort>BOOK</TontrShort> -->
      <!-- <TontrText>Books</TontrText> -->
    </ns1:pixiGetCategories>
  </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:pixiGetCategories>
      <!-- <TontrArtKey>3</TontrArtKey> -->
      <!-- <TontrShort>BOOK</TontrShort> -->
      <!-- <TontrText>Books</TontrText> -->
    </ns1:pixiGetCategories>
  </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 = [
    // 'TontrArtKey' => '3',
    // 'TontrShort' => 'BOOK',
    // 'TontrText' => 'Books',
];

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

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

Verwendete Tabellen

TontrArten · Lesen

SQL-Objekt:: dbo.pipiGetCategories