Unofficial Pixi-API-Documentation

by koempf24.de

pixiReadCodeTableValues

Pixi-Docs
Old Pixi-Docs

API call returns code table values

Since pixi version: 21.01 (9.0.23.54983) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
Id integer false

Code value Id

Type: int

Default value: NULL

Example: 123

Available from: 21.01 (9.0.23.54983)
RowCount integer false

Number of rows to return

Type: int

Default value: NULL

Example: 123

Available from: 21.01 (9.0.23.54983)
LanguageId integer false

Selected language for CodeDescription value

Type: int

Default value: 1

Example: 123

Available from: 21.01 (9.0.23.54983)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReadCodeTableValues>
      <Id>0</Id>
      <RowCount>0</RowCount>
      <LanguageId>0</LanguageId>
    </pixiReadCodeTableValues>
  </Body>
</Envelope>

Response

1. Code table information

Name Type Description
Id integer

Code table Id

Type: int

Available from: 25.06 (25.6.0.58802)
Code string

Code value

Type: varchar (100)

Available from: 25.06 (25.6.0.58802)
IsSystem boolean

Notes if the record is system and thus can not be changed

Type: bit

Available from: 25.06 (25.6.0.58802)
IsDefault boolean

Code is preselected as default value in UI

Type: bit

Available from: 25.06 (25.6.0.58802)
IsEnabled boolean

The code is enabled for display in UI

Type: bit

Available from: 25.06 (25.6.0.58802)
SortOrder integer

Order of column for display in UI (smaller is displayed first)

Type: int

Available from: 25.06 (25.6.0.58802)
CodeDescription string

Code description in selected language

Type: varchar (2000)

Available from: 25.06 (25.6.0.58802)
CodeTableTypeId integer

Code table type Id

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReadCodeTableValuesPost200TextXmlResponse>
  <Id>0</Id>
  <CodeTableTypeId>0</CodeTableTypeId>
  <Code>string</Code>
  <CodeDescription>string</CodeDescription>
  <IsEnabled>true</IsEnabled>
  <IsSystem>true</IsSystem>
  <SortOrder>0</SortOrder>
  <IsDefault>true</IsDefault>
</PixiReadCodeTableValuesPost200TextXmlResponse>

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:pixiReadCodeTableValues>
            <Id xsi:type="xsd:integer">123</Id>
            <RowCount xsi:type="xsd:integer">123</RowCount>
            <LanguageId xsi:type="xsd:integer">123</LanguageId>
        </ns1:pixiReadCodeTableValues>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadCodeTableValues', [
    'Id' => '123', // integer
    'RowCount' => '123', // integer
    'LanguageId' => '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);
}