Orderlines Read

pixiGetText

Returns the descriptive text for an object code; currently only order line status codes (`ORDERLINE_STATUS`) are supported.

Scalar function that translates a code into its text.

If ObjectType equals ORDERLINE_STATUS (case-insensitive, compared via UPPER), the function looks up the row in OrderStates whose State matches ObjectId and returns its StateText.
For any other ObjectType, or if no matching status exists, the function returns NULL.

The result is a single value of type varchar(1024).

Notes

The lookup uses NOLOCK, so uncommitted data may be read.
ObjectId is passed as varchar(100) and compared to State; implicit conversion depends on the column type of State, which is not visible in the code.
If several rows match, the value of the last row read is returned (variable assignment in SELECT).

Parameters

Parameter Type Default Description

Parameter	Type	Default	Description
`ObjectType` Required	varchar(100) string	–	Type of the object whose text is requested. Compared case-insensitively. Allowed values `ORDERLINE_STATUS` – Returns `StateText` of the order line status from `OrderStates`. Example: `ORDERLINE_STATUS`
`ObjectId` Required	varchar(100) string	–	Code of the object, for `ORDERLINE_STATUS` the status code (`State`) of the order line. Example: `AU`

ObjectType

Required

varchar(100)
string

–

Type of the object whose text is requested. Compared case-insensitively.

Allowed values

ORDERLINE_STATUS – Returns `StateText` of the order line status from `OrderStates`.

Example: ORDERLINE_STATUS

ObjectId

Required

varchar(100)
string

–

Code of the object, for ORDERLINE_STATUS the status code (State) of the order line.

Example: AU

Response

Result set 1 · Always

Single return value of the scalar function.

Column	Type	Description
`Result` Nullable	varchar(1024) string	Text of the status, or `NULL` if the object type is unsupported or the code is unknown.

Response example

<SqlRowSet1>
  <row>
    <Result>Ausgeliefert</Result>
  </row>
</SqlRowSet1>

Examples

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetText>
      <ObjectType>ORDERLINE_STATUS</ObjectType>
      <ObjectId>AU</ObjectId>
    </ns1:pixiGetText>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetText>
      <ObjectType>ORDERLINE_STATUS</ObjectType>
      <ObjectId>AU</ObjectId>
    </ns1:pixiGetText>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'ObjectType' => 'ORDERLINE_STATUS',
    'ObjectId' => 'AU',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetText', $soapArguments);

Tables used

OrderStates · Read

SQL object:: dbo.pipiGetText