Unofficial Pixi-API-Documentation

by koempf24.de

pixiReadTranslations

Pixi-Docs
Old Pixi-Docs

API call returns translation line records

Since pixi version: 21.01 (9.0.23.54983) Additional notes:

Orderlines Orders

Request

POST https://apigateway.descartes.com/tms/pixi/pixiReadTranslations

Request body

Name Type Required Description
RowCount integer false

Maximum number of records returned

Type: int

Default value: 1000

Example: 123

Available from: 21.01 (9.0.23.54983)
TranslationKey integer false

Translation line id. If @RowCount is NULL then it returns only this row, otherwise next @RowCount records.

Type: int

Default value: NULL

Example: 123

Available from: 21.01 (9.0.23.54983)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReadTranslations>
      <TranslationKey>0</TranslationKey>
      <RowCount>0</RowCount>
    </pixiReadTranslations>
  </Body>
</Envelope>

Response

1. Translations information

Name Type Description
LanguageID integer

Language Id (1-English, 2-German)

Type: int

Available from: 25.06 (25.6.0.58802)
DBObjectName string

Databse object name (grouping of translations per DB object name)

Type: varchar (255)

Available from: 25.06 (25.6.0.58802)
TranslationID string

Translation content Id (translation code)

Type: varchar (255)

Available from: 25.06 (25.6.0.58802)
TranslationKey integer

Translation table Id

Type: int

Available from: 25.06 (25.6.0.58802)
ApplicationName string

Application name (grouping of translations per application)

Type: varchar (255)

Available from: 25.06 (25.6.0.58802)
TranslationText string

Translated text

Type: varchar (2000)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReadTranslationsPost200TextXmlResponse>
  <TranslationKey>0</TranslationKey>
  <LanguageID>0</LanguageID>
  <TranslationID>string</TranslationID>
  <TranslationText>string</TranslationText>
  <ApplicationName>string</ApplicationName>
  <DBObjectName>string</DBObjectName>
</PixiReadTranslationsPost200TextXmlResponse>

HTTP Example

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}

<?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/"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:pixiReadTranslations>
            <RowCount xsi:type="xsd:integer">123</RowCount>
            <TranslationKey xsi:type="xsd:integer">123</TranslationKey>
        </ns1:pixiReadTranslations>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadTranslations', [
    'RowCount' => '123', // integer
    'TranslationKey' => '123', // integer
]);

function getPixiSoapClientResponse(string $method, array $arguments = [])
{
    $soapArguments = [];
    foreach ($arguments as $key => $value) {
        $soapArguments[] = new SoapVar($value, null, '', '', $key);
    }

    $soapClient = new SoapClient(null, [
        'login' => '...',
        'password' => '...',
        'uri' => 'https://apigateway.descartes.com/tms/pixi/',
        'location' => 'https://apigateway.descartes.com/tms/pixi/',
    ]);

    return $soapClient->__call($method, $soapArguments);
}