pixiReadTranslations · Pixi API documentation

Reads translation entries (language-specific texts) from the Translation table using keyset paging.

If TranslationKey is omitted or NULL, it is set to 0, so reading starts at the beginning of the table.
If RowCount is omitted or NULL, it is set to 1000.
The call returns at most RowCount rows whose TranslationKey is greater than the given TranslationKey, sorted by TranslationKey ascending.

To read all translations, start with TranslationKey = 0 (or omit it). Then call again with the highest TranslationKey of the previous page until fewer than RowCount rows come back.

Notes

Because both parameters are replaced by defaults when they are NULL, only the paging branch is ever executed. The code also contains branches for an exact lookup by TranslationKey and for an empty result, but these are unreachable.
Passing a specific TranslationKey does not return that entry. It returns the entries after it.
The table is read WITH (NOLOCK), so uncommitted changes may be visible.
RowCount = 0 returns no rows. A negative RowCount causes a SQL Server error from the TOP clause.
The column types are not visible in the code because the definition of the Translation table is not attached.

Tables used

Translation · Read

Parameter	Type	Default	Description
`TranslationKey`	int	NULL	Paging cursor. Only entries with a `TranslationKey` greater than this value are returned. `NULL` is treated as `0`. Example: `0`
`RowCount`	int	1000	Maximum number of rows returned. `NULL` is treated as `1000`. Example: `500`

Result set 1 · Always

Translation entries after the given key, sorted by TranslationKey ascending, limited to RowCount rows.

Column	Type	Description
`TranslationKey`	int	Unique key of the translation entry. Use the highest value of a page as the cursor for the next call.
`LanguageID` Nullable	string	Language of the translation.
`TranslationID` Nullable	string	Identifier of the translated text.
`TranslationText` Nullable	string	Translated text.
`ApplicationName` Nullable	string	Application the translation belongs to.
`DBObjectName` Nullable	string	Name of the database object the translation refers to.

Response example

<SqlRowSet1>
  <row>
    <TranslationKey>1</TranslationKey>
    <LanguageID>EN</LanguageID>
    <TranslationID>ORDER_STATUS_OPEN</TranslationID>
    <TranslationText>Open</TranslationText>
    <ApplicationName>pixi</ApplicationName>
    <DBObjectName>OrderStatus</DBObjectName>
  </row>
  <row>
    <TranslationKey>2</TranslationKey>
    <LanguageID>DE</LanguageID>
    <TranslationID>ORDER_STATUS_OPEN</TranslationID>
    <TranslationText>Offen</TranslationText>
    <ApplicationName>pixi</ApplicationName>
    <DBObjectName>OrderStatus</DBObjectName>
  </row>
</SqlRowSet1>

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:pixiReadTranslations>
      <!-- <TranslationKey>0</TranslationKey> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadTranslations>
  </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:pixiReadTranslations>
      <!-- <TranslationKey>0</TranslationKey> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadTranslations>
  </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 = [
    // 'TranslationKey' => '0',
    // 'RowCount' => '500',
];

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

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