pixiDispoClearSOrderlinesOnNEW · Pixi API documentation

Cleans up supplier orders (disposition) that are still in status NEW (StatusId = 1) for one creating user.

Reads the setting LogControl_DoNotDeleteOrderlinesOnNew. If it is 1, the call does nothing.
Resolves @CreateEmp to a user ID using inf.UserGetByName. No fallback user is used.
Deletes all rows in pixi.SupplierOrderLine that belong to supplier orders with StatusId = 1 and RecordCreatedByUserId equal to that user ID.
Deletes the supplier orders with StatusId = 1, created by that user, that no longer have any order lines.

Only orders created by the given user are affected. Orders of other users and orders in any other status stay unchanged. The call returns no result set.

Notes

If @CreateEmp does not exist in UCS_USERS, the user ID is NULL and nothing is deleted. The call gives no feedback in this case.
If the setting LogControl_DoNotDeleteOrderlinesOnNew does not exist, it counts as 0, so the deletion runs.
Both DELETE statements run without an explicit transaction. The subqueries read with NOLOCK.
The orders are deleted with a NOT IN check against all SupplierOrderId values of pixi.SupplierOrderLine. If any line has a NULL SupplierOrderId, no order is deleted.
An earlier deletion of history rows (SOrderlinesHist) is commented out and does not run.
The deletion is permanent. The call returns no rows and no row counts.

Tables used

SupplierOrderLine · Write supplierOrder · Write Settings · Read UCS_USERS · Read

Parameter	Type	Default	Description
`CreateEmp`	varchar(50) string	API	User name (from `UCS_USERS`) whose NEW supplier orders and their lines are deleted. Example: `API`

This call returns no result set.

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:pixiDispoClearSOrderlinesOnNEW>
      <!-- <CreateEmp>API</CreateEmp> -->
    </ns1:pixiDispoClearSOrderlinesOnNEW>
  </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:pixiDispoClearSOrderlinesOnNEW>
      <!-- <CreateEmp>API</CreateEmp> -->
    </ns1:pixiDispoClearSOrderlinesOnNEW>
  </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 = [
    // 'CreateEmp' => 'API',
];

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

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