Skip to main content
Omnitracs Knowledge Base

Delete Dictionary Entry


The deleteDictionaryEntry web service deletes a dictionary field/group entry from QTRACS/Portal.

A Dictionary Entry is a single field or group of fields used as part of a Macro Template for messaging in QTRACS/Portal.
For more information about the use of dictionary entries in Text and Macro Messaging see the Text and Macro Messaging Concepts page.

void deleteDictionaryEntry(String xmlTag) throws WSException

  • xmlTag: A unique string that identifies the XML integration tag of the dictionary entry to be deleted.


Things to note when attempting to delete a macro


Only custom dictionary entries can be deleted (standard entries are static and non-maintainable by the end user).
A dictionary entry that is in use in any macro cannot be deleted.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use QTRACS
- Can set up macros

Customer integrators are authorized to their own company's data only. 


001 Unknown error.
002 Required field not specified.
003 Authenticated company not specified.
004 Authenticated user not specified.
005 User is not authorized.
006 Invalid XML Tag name.
007 Cannot delete a standard dictionary entry.
008 Cannot delete a dictionary entry that is in use in a macro.
009 Macro cannot be modified once text messages are used for OT1.

Sample deleteDictionaryEntry Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, see the Web Service Security page.






Sample deleteDictionaryEntry Response

An empty response conveys success. If there was an error, an exception would have been thrown.


    <deleteDictionaryEntry />


  • Was this article helpful?