pixiGetSettings
Liefert den Wert einer einzelnen Pixi-Einstellung oder ohne Namensangabe eine Übersicht ausgewählter Einstellungen, Lizenzzähler und Stammdatenanzahlen.
Liest Systemeinstellungen aus der Tabelle Settings. Leere Zeichenketten in den Parametern werden als NULL behandelt.
Der Aufruf kennt drei Modi:
SettingName=LocID: liefert eine Zeile mitSettingName=LocIDund einemSettingValue, der alle Lager-IDs ausLocationjeweils gefolgt von;auflistet (z. B.001; 002;).- Beliebiger anderer
SettingName: liefert eine Zeile mit dem angefragten Namen und dessen Wert ausSettings(erster Treffer). Existiert die Einstellung nicht oder ist ihr WertNULL, istSettingValuegleich'0'. - Kein
SettingName(weggelassen oder leer): liefert eine Übersicht mit mehreren Zeilen:- die Einstellungen
EnablePrintingRules,BookExportDatevActive,FulfillmentBuyingOption,pixiLicences,ReservePrepaymentOrders,ScanInWithPiccoLink,EnablePersonalizedItems,SerialNumberValidityCheckEnabled,PixiMail_CreationEnabled,PixiMail_SendingEnabled,C_ItemImportEnabled,C_OrderImportEnabled,ReturnsEnabled,EnableDbCCP,Add_0_to_12_char_BarCode,default_quantity,APIUpdateItemBinCodes,NumberOfPiccoTerminals(nur sofern inSettingsvorhanden), Mobile_Licenses: Anzahl aktiver Benutzersitzungen mit Sitzungstyp 4 oder 5,Suppliers,Shops,Locations: Anzahl der Datensätze in den jeweiligen Tabellen,ShipVendors: alle Versanddienstleister-Namen, jeweils gefolgt von,,LocID: alle Lager-IDs, jeweils gefolgt von;,PIM:'1', wenn eine EinstellungShopUrlaufpim.pixi.euoderpim-beta.pixi.euverweist, sonst'0'. Ist die EinstellungC_OrderImportEnabledgleich1, werden zusätzlich die Kanaleinstellungen (C_ChannelSettings) geprüft.
- die Einstellungen
Die Übersichtszeilen werden per UNION zusammengeführt; doppelte Zeilen entfallen, eine Sortierreihenfolge ist nicht garantiert.
Hinweise
ShopIDundLocIDwerden an die interne Funktion zum Lesen der Einstellung übergeben, dort aber ignoriert. Shop- oder lagerspezifische Werte werden daher nicht geliefert; das Ergebnis ist immer der globale Wert ausSettings.- Eine fehlende Einstellung ist nicht von einer Einstellung mit dem Wert
'0'zu unterscheiden. - Alle Lesezugriffe erfolgen mit
NOLOCK; Werte können nicht festgeschriebene Änderungen enthalten. - Die Listen für
LocIDundShipVendorswerden mitFOR XML PATHerzeugt: Sie enden mit einem Trennzeichen, Sonderzeichen wie&können XML-maskiert erscheinen, und bei leerer Tabelle ist der WertNULL. - Im Übersichtsmodus wird
C_OrderImportEnabledmit der Zahl1verglichen; ein nicht numerischer Wert dieser Einstellung würde einen Konvertierungsfehler verursachen.
Parameter
| Parameter | Typ | Standardwert | Beschreibung |
|---|---|---|---|
SettingName
|
varchar(50) string |
– |
Name der zu lesenden Einstellung. Beispiel: |
ShopID
|
varchar(3) string |
– |
Shop-ID. Wird an die Einstellungsabfrage übergeben, hat derzeit aber keine Wirkung. Beispiel: |
LocID
|
varchar(3) string |
– |
Lager-ID. Wird an die Einstellungsabfrage übergeben, hat derzeit aber keine Wirkung. Beispiel: |
Antwort
Result-Set 1 · Wenn SettingName = LocID
Eine Zeile mit der Liste aller Lager-IDs.
| Spalte | Typ | Beschreibung |
|---|---|---|
SettingName
|
varchar(5) string |
Immer |
SettingValue
Kann leer sein |
nvarchar(max) string |
Alle Lager-IDs, jeweils gefolgt von |
Result-Set 2 · Wenn SettingName angegeben und nicht LocID ist
Eine Zeile mit der angefragten Einstellung und ihrem Wert.
| Spalte | Typ | Beschreibung |
|---|---|---|
SettingName
|
varchar(50) string |
Der angefragte Einstellungsname wie übergeben. |
SettingValue
|
varchar(8000) string |
Wert der Einstellung; |
Result-Set 3 · Wenn SettingName leer ist oder weggelassen wird
Übersicht ausgewählter Einstellungen, Lizenzzähler, Stammdatenanzahlen, Versanddienstleister, Lager-IDs und PIM-Kennzeichen; unsortiert.
| Spalte | Typ | Beschreibung |
|---|---|---|
SettingName
|
string |
Einstellungsname oder Name des berechneten Werts ( |
SettingValue
Kann leer sein |
nvarchar(max) string |
Einstellungswert, Anzahl als Text, getrennte Liste oder |
Beispielantwort
<SqlRowSet1>
<row>
<SettingName>LocID</SettingName>
<SettingValue>001; 002; </SettingValue>
</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:pixiGetSettings>
<!-- <SettingName>ReturnsEnabled</SettingName> -->
<!-- <ShopID>SHP</ShopID> -->
<!-- <LocID>001</LocID> -->
</ns1:pixiGetSettings>
</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:pixiGetSettings>
<!-- <SettingName>ReturnsEnabled</SettingName> -->
<!-- <ShopID>SHP</ShopID> -->
<!-- <LocID>001</LocID> -->
</ns1:pixiGetSettings>
</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 = [
// 'SettingName' => 'ReturnsEnabled',
// 'ShopID' => 'SHP',
// 'LocID' => '001',
];
$soapArguments = [];
foreach ($arguments as $name => $value) {
$soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}
$response = $soapClient->__soapCall('pixiGetSettings', $soapArguments);
Verwendete Tabellen
- SQL-Objekt:
- dbo.pipiGetSettings