Unofficial Pixi-API-Documentation

by koempf24.de

pixiImportGetChannels

Pixi-Docs
Old Pixi-Docs

API call returns pixi channels connected to external platforms

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

General

Request

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

Request body

Name Type Required Description

Request Example

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

Response

1. Status and result

Name Type Description
ChannelKey integer

ID of the channel

Type: int

Available from: / (25.7.0.59144)
ChannelName string

Channel name

Type: varchar (32)

Available from: / (25.7.0.59144)
ChannelType string

Channel type

Type: varchar (32)

Available from: / (25.7.0.59144)

Response Example

<PixiImportGetChannelsPost200TextXmlResponse>
  <ChannelKey>0</ChannelKey>
  <ChannelName>string</ChannelName>
  <ChannelType>string</ChannelType>
</PixiImportGetChannelsPost200TextXmlResponse>

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:pixiImportGetChannels/>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiImportGetChannels');

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