pixiTagGet

Get tags, result can be filtered by DateFrom, DateTo or by TypeId. By default 1000 rows is returned.

Since pixi version: 19.06 (9.0.4.39859) Additional notes:

Orderlines Orders

Request

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

Request body

Name	Type	Required	Description
DateTo	string	false	Filter tags by date when they were created - to date. Type: smalldatetime Default value: NULL Example: 2019-01-31 23:59:59 Available from: 19.06 (9.0.4.39859)
TypeId	integer	false	Filter tags by type id. Type: int Default value: NULL Example: 1 Available from: 19.06 (9.0.4.39859)
DateFrom	string	false	Filter tags by date when they were created - from date. Type: smalldatetime Default value: NULL Example: 2019-01-01 00:00:00 Available from: 19.06 (9.0.4.39859)
RowCount	integer	false	Number of records returned, by default 1000. Type: int Default value: 1000 Example: 123 Available from: 19.06 (9.0.4.39859)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiTagGet>
      <RowCount>0</RowCount>
      <DateFrom>string</DateFrom>
      <DateTo>string</DateTo>
      <TypeId>0</TypeId>
    </pixiTagGet>
  </Body>
</Envelope>

Response

1. List of Tags

Name	Type	Description
Name	string	Tag name Type: varchar (50) Available from: 25.06 (25.6.0.58802)
TagId	string	Tag id Type: integer Available from: 25.06 (25.6.0.58802)
TypeId	string	Tag type id Type: integer Available from: 25.06 (25.6.0.58802)
TypeName	string	Tag type name Type: varchar (255) Available from: 25.06 (25.6.0.58802)
CreateDate	string	Date when record was created Type: smalldatetime Available from: 25.06 (25.6.0.58802)
Description	string	Tag description Type: varchar (4000) Available from: 25.06 (25.6.0.58802)
IsSystemTag	string	Flag if tag is system tag Type: boolean Available from: 25.06 (25.6.0.58802)

Response Example

<PixiTagGetPost200TextXmlResponse>
  <TagId>string</TagId>
  <Name>string</Name>
  <Description>string</Description>
  <IsSystemTag>string</IsSystemTag>
  <CreateDate>string</CreateDate>
  <TypeId>string</TypeId>
  <TypeName>string</TypeName>
</PixiTagGetPost200TextXmlResponse>

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:pixiTagGet>
            <DateTo xsi:type="xsd:string">2019-01-31 23:59:59</DateTo>
            <TypeId xsi:type="xsd:integer">1</TypeId>
            <DateFrom xsi:type="xsd:string">2019-01-01 00:00:00</DateFrom>
            <RowCount xsi:type="xsd:integer">123</RowCount>
        </ns1:pixiTagGet>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiTagGet', [
    'DateTo' => '2019-01-31 23:59:59', // string
    'TypeId' => '1', // integer
    'DateFrom' => '2019-01-01 00:00:00', // string
    'RowCount' => '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);
}

Unofficial Pixi-API-Documentation

by koempf24.de