pixiTagDelete · Pixi API documentation

Deletes one tag from Tag together with all of its assignments in TagMatch. Tags are used to label objects such as items (Artikel) or orders (Aufträge).

The tag can be identified in two ways:

by TagId, or
by the combination of TypeId and Name. Both values are required together.

The parameters are checked in this order:

If all three parameters are missing, or only one of TypeId and Name is passed, the call returns an error about missing mandatory parameters.
If TagId is passed but no tag with this ID exists, the call returns Tag does not exist.
If TagId is not passed and no tag matches TypeId and Name, the call also returns Tag does not exist.
If the tag found is a system tag (IsSystemTag = 1), it cannot be deleted.
If TagId and TypeId/Name are all passed and point to two different tags, the call returns an error.

If all checks pass, the call first deletes every TagMatch row of the tag, which removes the tag from all assigned objects. It then deletes the tag itself. The call always returns a single row with Status and Message.

Notes

The call runs in its own transaction. If a transaction is already open, it uses a savepoint instead. On an unexpected error the changes are rolled back, the error is logged via log.InsertError and Status = Error is returned with the first 80 characters of the SQL error message.
Errors are never raised as SqlMessage. Always evaluate the Status column.
Pitfall: if TagId is passed together with a TypeId/Name pair that matches no tag, the conflict check does not apply. In that case the tag with TagId is deleted.
Passing TagId together with only TypeId or only Name returns the missing-parameters error, even though TagId alone would be enough.
The checks read Tag with NOLOCK. The deletes use ROWLOCK.
The meaning of the TypeId values (for example item or order tags) is not defined in this code.

Tables used

Tag · Write TagMatch · Write

Parameter	Type	Default	Description
`TagId`	int	NULL	ID of the tag to delete. Alternative to the combination of `TypeId` and `Name`. Example: `42`
`TypeId`	int	NULL	Type of the tag (`Tag.TypeId`). Must be passed together with `Name` if the tag is identified by name. Example: `1`
`Name`	varchar(50) string	NULL	Name of the tag (`Tag.Name`). Must be passed together with `TypeId`. Example: `Sale2024`

Result set 1 · Always

One status row with the result of the delete operation.

Column	Type	Description
`Status`	varchar(10) string	`Success` if the tag was deleted, otherwise `Error`.
`Message`	varchar(100) string	Success message or error description.

Response example

<SqlRowSet1>
  <row>
    <Status>Success</Status>
    <Message>Tag was successfully deleted. Tag was also removed from assigned objects</Message>
  </row>
</SqlRowSet1>

Status	Message	Cause
Error	Tag could not be deleted. Mandatory parameters TypeId or Name or TagId are missing	No parameter was passed, or only one of `TypeId` and `Name` was passed. Pass either `TagId` or both `TypeId` and `Name`.
Error	Tag could not be deleted, Tag does not exist	No tag exists with the given `TagId`, or, if `TagId` is not passed, no tag matches `TypeId` and `Name`.
Error	System Tags (IsSystemTag) cannot be deleted	The tag found is marked as a system tag (`IsSystemTag` = 1). System tags cannot be deleted.
Error	Tag could not be deleted, use either TagId parameter or combination of TypeId and Name parameters	`TagId` and `TypeId`/`Name` point to two different existing tags. Pass only one way of identifying the tag.
Error	Unexpected error: "{error message}"	An unexpected SQL error occurred during the delete, for example a lock or constraint problem. The transaction is rolled back and the error is logged.

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:pixiTagDelete>
      <!-- <TagId>42</TagId> -->
      <!-- <TypeId>1</TypeId> -->
      <!-- <Name>Sale2024</Name> -->
    </ns1:pixiTagDelete>
  </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:pixiTagDelete>
      <!-- <TagId>42</TagId> -->
      <!-- <TypeId>1</TypeId> -->
      <!-- <Name>Sale2024</Name> -->
    </ns1:pixiTagDelete>
  </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 = [
    // 'TagId' => '42',
    // 'TypeId' => '1',
    // 'Name' => 'Sale2024',
];

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

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