Items Lesen

pixiReadItemTags

Liefert die in Pixi definierten Artikel-Tags sortiert nach Tag-Schlüssel, mit Paging über Startschlüssel und Zeilenanzahl.

Liest Tags vom Typ Artikel (TypeId = 1) aus der Tag-Tabelle.

Es werden nur Tags geliefert, deren Schlüssel größer als Start ist.
Das Ergebnis ist aufsteigend nach TagKey sortiert und auf RowCount Zeilen begrenzt.
Ist RowCount NULL oder kleiner als 1, werden 1000 Zeilen geliefert.

Paging: Für die nächste Seite wird der höchste TagKey der vorherigen Seite als Start übergeben. Dies wird wiederholt, bis weniger als RowCount Zeilen zurückkommen.

Hinweise

Die Tabelle wird mit NOLOCK gelesen, daher können nicht festgeschriebene Änderungen sichtbar sein. Tags anderer Typen (andere TypeId-Werte) werden nicht geliefert. Der Aufruf listet nur Tag-Definitionen; welche Artikel ein Tag tragen, wird nicht geliefert.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`Start`	int	-99999999	Es werden nur Tags mit einem Schlüssel größer als dieser Wert geliefert. Für Paging den letzten `TagKey` der vorherigen Seite verwenden. Beispiel: `0`
`RowCount`	int	1000	Maximale Anzahl zu liefernder Zeilen. `NULL` oder Werte kleiner als 1 werden durch 1000 ersetzt. Beispiel: `500`

Antwort

Result-Set 1 · Immer

Artikel-Tags mit einem Schlüssel größer als Start, aufsteigend nach TagKey sortiert, höchstens RowCount Zeilen.

Spalte	Typ	Beschreibung
`TagKey`	int	Eindeutiger Schlüssel des Tags.
`TagName` Kann leer sein	string	Name des Tags.
`TagDescription` Kann leer sein	string	Beschreibung des Tags.
`IsSystemTag` Kann leer sein	boolean	Gibt an, ob das Tag ein System-Tag ist.

Beispielantwort

<SqlRowSet1>
  <row>
    <TagKey>3</TagKey>
    <TagName>Bestseller</TagName>
    <TagDescription>Top selling items</TagDescription>
    <IsSystemTag>false</IsSystemTag>
  </row>
  <row>
    <TagKey>7</TagKey>
    <TagName>Fragile</TagName>
    <TagDescription>Handle with care</TagDescription>
    <IsSystemTag>false</IsSystemTag>
  </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:pixiReadItemTags>
      <!-- <Start>0</Start> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadItemTags>
  </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:pixiReadItemTags>
      <!-- <Start>0</Start> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadItemTags>
  </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 = [
    // 'Start' => '0',
    // 'RowCount' => '500',
];

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

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

Verwendete Tabellen

Tag · Lesen

SQL-Objekt:: dbo.pipiReadItemTags