Create Dictionary Entry

Last updated
Save as PDF

createDictionaryEntry

The createDictionaryEntry web service creates a dictionary field/group entry on 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 createDictionaryEntry(DictionaryEntry entry) throws WSException

entry: A Dictionary Entry object that defines the dictionary entry.

The following Dictionary Entry fields are ignored by this web service:

dictionaryType: Only custom dictionary entries can be created (standard entries are static and non-maintainable by the end user).
direction: Use restrictions are automatically determined when creating a macro based on the mobile data type.
inUse: Dictionary usage is automatically set based on if the dictionary is a part of a macro.

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.

Exceptions

001 Unknown error.
002 Null value in one of the SQL null indicator fields.
003 Authenticated company not specified.
004 Authenticated user not specified.
005 User is not authorized.
006 Invalid entry name.
007 Entry name must be unique.
008 Invalid XML Tag name.
009 XML Tag name must be unique.
010 Invalid mobile data type specified.
011 Invalid mobile data length specified.
012 Enumerations must be included for specified mobile data type.
013 Invalid entry type.
014 Invalid entry description.
015 Specified mobile data type does not require enumerations.
016 Enumerations must be numeric for specified mobile data type.
017 Invalid integer range values specified.
018 Invalid enumeration value.
019 Macro cannot be modified once text messages are used for OT1.

Sample createDictionaryEntry Request

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

<soap:Body>

<createDictionaryEntry xmlns="http://websvcs.qtracswebws">

<entry xmlns="">

<description>A sample custom item list dictionary entry.</description>

<dictionaryType xsi:nil="true" />

<direction xsi:nil="true" />

<entryType>F</entryType>

<enumerations>item1,item2,item3,item4</enumerations>

<mobileDataType>21</mobileDataType>

<mobileLength>5</mobileLength>

<inUse>false</inUse>

<name>Custom Item List</name>

<xmlTag>customItemList</xmlTag>

</entry>

</createDictionaryEntry>

</soap:Body>

Sample createDictionaryEntry Response

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

<soap:Body>

<createDictionaryEntry />

</soap:Body>