Unofficial Pixi-API-Documentation

by koempf24.de

pixiCAInsertMatch

Pixi-Docs
Old Pixi-Docs

Inserts a Match to a Event

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

Customers

Request

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

Request body

Name Type Required Description
CAref1 integer true

CAref 1

Type: int

Default value:

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
CAref2 integer true

CAref 2

Type: int

Default value:

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
ResultCode string false

Result Code

Type: char

Default value: NULL

Example: 201, 202, 403

Available from: LOU Official - Update 46 (6.9.46.27927)
ResultText string false

Result Text

Type: varchar(1024)

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)
MatchAmount number true

Match Amount

Type: money

Default value:

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCAInsertMatch>
      <CAref1>0</CAref1>
      <CAref2>0</CAref2>
      <MatchAmount>0</MatchAmount>
      <ResultCode>string</ResultCode>
      <ResultText>string</ResultText>
    </pixiCAInsertMatch>
  </Body>
</Envelope>

Response

1. Status response

Name Type Description
ResultCode string

Gibt Status 200 zur�ck bei erfolgreicher Ausf�hrung.

Type: varchar

Available from: / (25.7.0.59144)
ResultText string

Gibt die Status- Bzw. Fehlermeldung zur�ck.

Type: varchar

Available from: / (25.7.0.59144)

Response Example

<PixiCAInsertMatchPost200TextXmlResponse>
  <ResultCode>string</ResultCode>
  <ResultText>string</ResultText>
</PixiCAInsertMatchPost200TextXmlResponse>

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:pixiCAInsertMatch>
            <CAref1 xsi:type="xsd:integer">123</CAref1> <!-- required -->
            <CAref2 xsi:type="xsd:integer">123</CAref2> <!-- required -->
            <ResultCode xsi:type="xsd:string">201, 202, 403</ResultCode>
            <ResultText xsi:type="xsd:string">abc</ResultText>
            <MatchAmount xsi:type="xsd:number">123</MatchAmount> <!-- required -->
        </ns1:pixiCAInsertMatch>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCAInsertMatch', [
    'CAref1' => '123', // integer (required)
    'CAref2' => '123', // integer (required)
    'ResultCode' => '201, 202, 403', // string
    'ResultText' => 'abc', // string
    'MatchAmount' => '123', // number (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);
}