General Lesen

pixiReadCodeTableValues

Liefert Codetabellenwerte aus pixi.CodeTableValue mit übersetzter Beschreibung, entweder einen einzelnen Wert per Id oder eine Seite von Werten nach einer Id.

Liest Einträge der Codetabelle pixi.CodeTableValue zusammen mit ihrem Beschreibungstext aus dbo.Translation.

Wird Id nicht übergeben, wird der Wert auf 0 gesetzt.
Es werden die Übersetzungen mit DBObjectName = 'CodeTableValue' und LanguageID = @LanguageId geladen. Die Zuordnung erfolgt über die Id des Werts.
Danach arbeitet der Aufruf in einem von zwei Modi:
- Paging-Modus (RowCount gesetzt): liefert höchstens RowCount Werte mit Id > @Id, sortiert nach Id aufsteigend. Für die nächste Seite wird die letzte Id der vorherigen Seite als Id übergeben. Für den Start wird Id = 0 übergeben oder weggelassen.
- Einzelmodus (RowCount nicht gesetzt): liefert den Wert mit Id = @Id.

Die Verknüpfung mit den Übersetzungen ist ein Inner Join. Werte ohne Übersetzung in der angeforderten Sprache werden nicht geliefert.

Hinweise

Alle Lesezugriffe verwenden NOLOCK, daher können auch nicht festgeschriebene Daten erscheinen.
Werden Id und RowCount beide weggelassen, wird der Wert mit Id = 0 gesucht. Das Ergebnis ist in der Regel leer. Zum Lesen aller Werte wird RowCount übergeben.
Der Code enthält einen dritten Zweig, der eine leere Ergebnismenge liefert. Dieser Zweig wird nie ausgeführt, da Id bei NULL immer auf 0 gesetzt wird.
Ein negativer RowCount führt zu einem SQL-Fehler bei TOP.
LanguageId ist standardmäßig 1. Für welche Sprache diese ID steht, hängt vom Inhalt von dbo.Translation ab.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`Id`	int	NULL	Ohne `RowCount`: die `Id` des zu liefernden Codetabellenwerts. Mit `RowCount`: es werden Werte mit einer größeren `Id` geliefert (Paging). `NULL` wird als `0` behandelt. Beispiel: `0`
`RowCount`	int	NULL	Maximale Anzahl Zeilen pro Seite. Ist der Wert gesetzt, arbeitet der Aufruf im Paging-Modus (`Id > @Id`, sortiert nach `Id`). Bei `NULL` wird ein einzelner Wert per `Id` geliefert. Beispiel: `100`
`LanguageId`	int	1	Sprache des Beschreibungstexts (`LanguageID` in `dbo.Translation`). Es werden nur Werte mit einer Übersetzung in dieser Sprache geliefert. Beispiel: `1`

Antwort

Result-Set 1 · Immer. Enthält einen Wert (Einzelmodus) oder bis zu `RowCount` Werte (Paging-Modus); die Ergebnismenge kann leer sein.

Codetabellenwerte mit übersetzter Beschreibung.

Spalte	Typ	Beschreibung
`Id`	int	Eindeutige ID des Codetabellenwerts; dient als `Id` für die nächste Seite.
`CodeTableTypeId` Kann leer sein	int	ID des Codetabellentyps, zu dem der Wert gehört.
`Code` Kann leer sein	string	Code des Werts.
`CodeDescription` Kann leer sein	string	Beschreibungstext aus `dbo.Translation` in der angeforderten Sprache.
`IsEnabled` Kann leer sein	boolean	Gibt an, ob der Wert aktiv ist.
`IsSystem` Kann leer sein	boolean	Gibt an, ob es sich um einen Systemwert handelt.
`SortOrder` Kann leer sein	int	Sortierreihenfolge des Werts innerhalb des Codetabellentyps.
`IsDefault` Kann leer sein	boolean	Gibt an, ob der Wert der Standardwert des Codetabellentyps ist.

Beispielantwort

<SqlRowSet1>
  <row>
    <Id>1</Id>
    <CodeTableTypeId>1</CodeTableTypeId>
    <Code>STD</Code>
    <CodeDescription>Standard</CodeDescription>
    <IsEnabled>true</IsEnabled>
    <IsSystem>true</IsSystem>
    <SortOrder>1</SortOrder>
    <IsDefault>true</IsDefault>
  </row>
  <row>
    <Id>2</Id>
    <CodeTableTypeId>1</CodeTableTypeId>
    <Code>EXP</Code>
    <CodeDescription>Express</CodeDescription>
    <IsEnabled>true</IsEnabled>
    <IsSystem>false</IsSystem>
    <SortOrder>2</SortOrder>
    <IsDefault>false</IsDefault>
  </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:pixiReadCodeTableValues>
      <!-- <Id>0</Id> -->
      <!-- <RowCount>100</RowCount> -->
      <!-- <LanguageId>1</LanguageId> -->
    </ns1:pixiReadCodeTableValues>
  </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:pixiReadCodeTableValues>
      <!-- <Id>0</Id> -->
      <!-- <RowCount>100</RowCount> -->
      <!-- <LanguageId>1</LanguageId> -->
    </ns1:pixiReadCodeTableValues>
  </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 = [
    // 'Id' => '0',
    // 'RowCount' => '100',
    // 'LanguageId' => '1',
];

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

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

Verwendete Tabellen

Translation · Lesen CodeTableValue · Lesen

SQL-Objekt:: dbo.pipiReadCodeTableValues