pixiMetadata

Looks up the input parameters of an API call in the SQL Server catalog view INFORMATION_SCHEMA.PARAMETERS of the current database.

Every occurrence of pixi in procedure is replaced by pipi. The SOAP name (pixiItemSearch) and the SQL name (pipiItemSearch) can therefore both be passed.
If the resulting name does not start with pipi, a status row with ErrNr = 403 and ErrMessage = No such API call is returned.
Then the parameters of the object are always returned:
- only objects in the current database (SPECIFIC_CATALOG = DB_NAME()),
- only parameters with PARAMETER_MODE = 'IN',
- the leading @ is removed from the parameter name,
- sorted by the declared parameter position.

If the call does not exist, the parameter result set is empty.

Notes

After the error row the procedure does not stop. In that case two result sets are returned: the error row in SqlRowSet1 and the (usually empty) parameter list in SqlRowSet2. Without an error the parameter list is SqlRowSet1.
Because execution continues, the parameters of a non-pipi object are still returned if an object with that name exists.
REPLACE affects every occurrence of pixi in the name, not only the prefix. Case sensitivity of the replacement and the prefix check depends on the database collation.
OUTPUT parameters (mode INOUT) and the return value of scalar functions are not listed. Default values and whether a parameter is required are not returned.
CHARACTER_MAXIMUM_LENGTH is NULL for non-character types and -1 for (max) types.
Visibility in INFORMATION_SCHEMA depends on the permissions of the database user.
The catalog view is read with NOLOCK.

Tables used

PARAMETERS · Read

Parameter	Type	Default	Description
`procedure` Required	varchar(50) string	–	Name of the API call whose parameters are requested. Either the SOAP name (`pixi…`) or the SQL name (`pipi…`). Example: `pixiGetItemInfo`

Result set 1 · Only if the name (after replacing `pixi` with `pipi`) does not start with `pipi`.

Error status row.

Column	Type	Description
`ErrNr`	int	Error number, always `403`.
`ErrMessage`	varchar(16) string	Error text `No such API call`.

Result set 2 · Always; empty if no matching object exists in the current database.

One row per input parameter of the call, ordered by declared position.

Column	Type	Description
`CallName` Nullable	nvarchar(128) string	SQL name of the object (`pipi…`).
`ParameterName` Nullable	nvarchar(128) string	Parameter name without the leading `@`, as used as SOAP element name.
`DataType` Nullable	nvarchar(128) string	SQL data type of the parameter, e.g. `varchar`, `int`, `datetime`.
`DataTypeLength` Nullable	int	Maximum length in characters for character types; `-1` for `(max)`, `NULL` for other types.

Response example

<SqlRowSet1>
  <row>
    <CallName>pipiMetadata</CallName>
    <ParameterName>procedure</ParameterName>
    <DataType>varchar</DataType>
    <DataTypeLength>50</DataTypeLength>
  </row>
</SqlRowSet1>

Status	Message	Cause
403	No such API call	The passed name does not start with `pixi` or `pipi`. Pass the SOAP or SQL name of an API call. The parameter result set follows anyway.

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:pixiMetadata>
      <procedure>pixiGetItemInfo</procedure>
    </ns1:pixiMetadata>
  </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:pixiMetadata>
      <procedure>pixiGetItemInfo</procedure>
    </ns1:pixiMetadata>
  </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 = [
    'procedure' => 'pixiGetItemInfo',
];

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

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

Notes

Tables used

Result set 1 · Only if the name (after replacing pixi with pipi) does not start with pipi.

Result set 2 · Always; empty if no matching object exists in the current database.

Response example

Result set 1 · Only if the name (after replacing `pixi` with `pipi`) does not start with `pipi`.