Unofficial Pixi-API-Documentation

by koempf24.de

pixiMetadata

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

API Call for getting metadata for an API call

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

General

Request

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

Request body

Name Type Required Description
procedure string true

API Call name

Type: varchar(50)

Default value:

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiMetadata>
      <procedure>string</procedure>
    </pixiMetadata>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
CallName string

API Call Name

Type: sysname

Available from: 25.06 (25.6.0.58802)
DataType string

Parameter Data Type

Type: sysname

Available from: 25.06 (25.6.0.58802)
ParameterName string

Parameter Name

Type: sysname

Available from: 25.06 (25.6.0.58802)
DataTypeLength integer

Data Type length (if available)

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiMetadataPost200TextXmlResponse>
  <CallName>string</CallName>
  <ParameterName>string</ParameterName>
  <DataType>string</DataType>
  <DataTypeLength>0</DataTypeLength>
</PixiMetadataPost200TextXmlResponse>

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:pixiMetadata>
            <procedure xsi:type="xsd:string">abcdef</procedure> <!-- required -->
        </ns1:pixiMetadata>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiMetadata', [
    'procedure' => 'abcdef', // string (required)
]);

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);
}