Unofficial Pixi-API-Documentation

by koempf24.de

pixiImportGetXML

Pixi-Docs
Old Pixi-Docs

Gets an XML with Status and everything

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

General

Request

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

Request body

Name Type Required Description
LogKeyXML integer false

XML Id

Type: int

Default value: 0

Example: 25

Available from: LOU Official - Update 46 (6.9.46.27927)
XMLLogKey integer false

XML Id

Type: int

Default value: 0

Example: 25

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiImportGetXML>
      <XMLLogKey>0</XMLLogKey>
      <LogKeyXML>0</LogKeyXML>
    </pixiImportGetXML>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Error string

error if there was any

Type: varchar

Available from: / (25.7.0.59144)
Source string

Source of this XML

Type: varchar

Available from: / (25.7.0.59144)
Status string

status of this XML XIM = XML is imported XER = error in this XML XPR = xml processed COC = constraints checked

Type: varchar

Available from: / (25.7.0.59144)
CreateEmp string

Creator

Type: varchar

Available from: / (25.7.0.59144)
UpdateEmp string

update users

Type: varchar

Available from: / (25.7.0.59144)
XMLLogKey integer

ID of the XML

Type: int

Available from: / (25.7.0.59144)
ChannelRef integer

channel

Type: int

Available from: / (25.7.0.59144)
CreateDate string

create date

Type: datetime

Available from: / (25.7.0.59144)
UpdateDate string

update date

Type: datetime

Available from: / (25.7.0.59144)
XMLRequest string

XML request

Type: varchar

Available from: / (25.7.0.59144)
XMLResponse string

XML response

Type: varchar

Available from: / (25.7.0.59144)
XmlRequestXml string

XML request

Type: xml

Available from: / (25.7.0.59144)
XmlResponseXml string

XML response

Type: xml

Available from: / (25.7.0.59144)
OperationTypeRef integer

Operation type for this XML

Type: int

Available from: / (25.7.0.59144)
AttemptsToProcess integer

attempts to process

Type: int

Available from: / (25.7.0.59144)
XmlRequestCastErrorNr integer

XML request error code

Type: int

Available from: / (25.7.0.59144)
XmlResponseCastErrorNr integer

XML response error code

Type: int

Available from: / (25.7.0.59144)
XmlRequestCastErrorMessage string

XML request error message

Type: varchar

Available from: / (25.7.0.59144)
XmlResponseCastErrorMessage string

XML response error message

Type: varchar

Available from: / (25.7.0.59144)

Response Example

<PixiImportGetXMLPost200TextXmlResponse>
  <XMLLogKey>0</XMLLogKey>
  <Source>string</Source>
  <XMLRequest>string</XMLRequest>
  <XMLResponse>string</XMLResponse>
  <Status>string</Status>
  <OperationTypeRef>0</OperationTypeRef>
  <CreateEmp>string</CreateEmp>
  <CreateDate>string</CreateDate>
  <UpdateEmp>string</UpdateEmp>
  <UpdateDate>string</UpdateDate>
  <ChannelRef>0</ChannelRef>
  <AttemptsToProcess>0</AttemptsToProcess>
  <Error>string</Error>
  <XmlRequestXml>string</XmlRequestXml>
  <XmlResponseXml>string</XmlResponseXml>
  <XmlRequestCastErrorNr>0</XmlRequestCastErrorNr>
  <XmlResponseCastErrorNr>0</XmlResponseCastErrorNr>
  <XmlRequestCastErrorMessage>string</XmlRequestCastErrorMessage>
  <XmlResponseCastErrorMessage>string</XmlResponseCastErrorMessage>
</PixiImportGetXMLPost200TextXmlResponse>

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:pixiImportGetXML>
            <LogKeyXML xsi:type="xsd:integer">25</LogKeyXML>
            <XMLLogKey xsi:type="xsd:integer">25</XMLLogKey>
        </ns1:pixiImportGetXML>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiImportGetXML', [
    'LogKeyXML' => '25', // integer
    'XMLLogKey' => '25', // 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);
}