pixiGetStandardReturnReasons
Liefert die Liste der Standard-Retourengründe auf Deutsch oder Englisch aus der Tabelle der Standardgründe, einer Einstellung und der Codetabelle für Retourengründe.
Stellt eine Liste von Retourengründen aus drei Quellen zusammen und liefert sie als eine Ergebnismenge.
Sprachauswahl. LanguageID = 1 wählt Deutsch; jeder andere Wert, auch NULL, wählt Englisch. Intern wechselt die Prozedur auf die Tabellenkonvention von Pixi, in der 1 = Englisch und 2 = Deutsch gilt, und filtert die Tabellen mit diesem Wert.
Quellen
- Einträge aus
RET_STANDARD_REASONSin der gewählten Sprache. Sie liefernRET_REASON_IDundREASON_TEXT.RET_REASON_CODEundLANGUAGEIDsindNULL. - Die Einstellung
CSD_ReturnWizardReasons_Deutsch(Deutsch) bzw.CSD_ReturnWizardReasons_English(andere Sprachen). Ihr Wert ist eine durch Semikolon getrennte Liste. Jeder Eintrag wird zu einer Zeile mit getrimmtem Text (max. 100 Zeichen) undRET_REASON_ID=NULL. Dieser Teil wird perUNIONmit Quelle 1 verbunden, identische Zeilen aus Quelle 1 und 2 erscheinen daher nur einmal. - Einträge aus
pixi.CodeTableValuemitCodeTableTypeId=2(Retourengründe), verknüpft mit ihremTranslation-Eintrag (DBObjectName=CodeTableValue) in der gewählten Sprache. Diese Zeilen liefern die ID aus der Codetabelle, den übersetzten Text und denCode.LANGUAGEIDwird in die Konvention des Aufrufers zurückgerechnet (1= Deutsch). Sie werden perUNION ALLangehängt, Duplikate werden hier also nicht entfernt.
Filter. Mit OnlyReturnReasonsFromPixiWeb = 1 werden nur Zeilen mit RET_REASON_ID geliefert. Damit entfallen die Gründe aus der Einstellung (Quelle 2).
Sortierung. Die Zeilen werden nach RET_REASON_CODE sortiert. Zeilen ohne Code (NULL) stehen vorne, ihre Reihenfolge untereinander ist nicht festgelegt.
Hinweise
- Die Sprachkonvention des Parameters (
1= Deutsch) ist umgekehrt zur Konvention der Tabellen (1= Englisch,2= Deutsch). Nur die SpalteLANGUAGEIDder Zeilen aus der Codetabelle wird in der Konvention des Aufrufers geliefert; alle anderen Zeilen liefernNULL. - Existiert die Einstellung nicht oder ist sie leer, liefert Quelle 2 keine Zeilen.
- Ein abschließendes oder doppeltes Semikolon im Wert der Einstellung erzeugt Zeilen mit leerem
REASON_TEXT. - Zeichen wie
&oder<im Wert der Einstellung können die Umwandlung der Liste in XML scheitern lassen; der Aufruf liefert dann einen SQL-Fehler. Settings,RET_STANDARD_REASONSundCodeTableValuewerden mitNOLOCKgelesen;Translationohne Sperrhinweis.- Der Name der Einstellung wird per
LIKEverglichen, wobei_ein Platzhalter für ein einzelnes Zeichen ist. In der Praxis ist der Vergleich exakt. - Nur lesend; es wird lediglich eine temporäre Tabelle verwendet.
Parameter
| Parameter | Typ | Standardwert | Beschreibung |
|---|---|---|---|
LanguageID
|
int | 1 |
Sprache der Texte der Retourengründe: Erlaubte Werte
Beispiel: |
OnlyReturnReasonsFromPixiWeb
|
bit boolean |
0 |
Bei Erlaubte Werte
Beispiel: |
Antwort
Result-Set 1 · Immer
Retourengründe in der gewählten Sprache, sortiert nach RET_REASON_CODE.
| Spalte | Typ | Beschreibung |
|---|---|---|
RET_REASON_ID
Kann leer sein |
int |
ID aus |
REASON_TEXT
Kann leer sein |
varchar(max) string |
Text des Retourengrunds. |
RET_REASON_CODE
Kann leer sein |
varchar(100) string |
Code aus |
LANGUAGEID
Kann leer sein |
int |
Sprache der Zeilen aus der Codetabelle in der Konvention des Aufrufers ( |
Beispielantwort
<SqlRowSet1>
<row>
<RET_REASON_ID>3</RET_REASON_ID>
<REASON_TEXT>Artikel defekt</REASON_TEXT>
</row>
<row>
<RET_REASON_ID>17</RET_REASON_ID>
<REASON_TEXT>Falsche Größe</REASON_TEXT>
<RET_REASON_CODE>SIZE</RET_REASON_CODE>
<LANGUAGEID>1</LANGUAGEID>
</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:pixiGetStandardReturnReasons>
<!-- <LanguageID>1</LanguageID> -->
<!-- <OnlyReturnReasonsFromPixiWeb>0</OnlyReturnReasonsFromPixiWeb> -->
</ns1:pixiGetStandardReturnReasons>
</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:pixiGetStandardReturnReasons>
<!-- <LanguageID>1</LanguageID> -->
<!-- <OnlyReturnReasonsFromPixiWeb>0</OnlyReturnReasonsFromPixiWeb> -->
</ns1:pixiGetStandardReturnReasons>
</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 = [
// 'LanguageID' => '1',
// 'OnlyReturnReasonsFromPixiWeb' => '0',
];
$soapArguments = [];
foreach ($arguments as $name => $value) {
$soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}
$response = $soapClient->__soapCall('pixiGetStandardReturnReasons', $soapArguments);
Verwendete Tabellen
- SQL-Objekt:
- dbo.pipiGetStandardReturnReasons