Get Dictionary Entry

Last updated
Save as PDF

getDictionaryEntry

The getDictionaryEntry web service retrieves information about 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.

DictionaryEntry getDictionaryEntry(String companyId, String xmlTag) throws WSException

companyId: (optional) A string, maximum length 10, specifying the unique company identifier.
NOTE: If no companyId is specified, the company of the authorized user making the call will be used.
xmlTag: A string that identifies the XML integration tag of the dictionary entry to be retrieved.

For specific information about the DictionaryEntry object returned by this web service, see the Dictionary Entry page.

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 XML Tag name.
007 Error acquiring mobile data type information.
008 Invalid company id.

Sample getDictionaryEntry Request

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

<soap:Body>

<getDictionaryEntry>

<companyId>MYCOMPANY</companyId>

<xmlTag>odometer</xmlTag>

</getDictionaryEntry>

</soap:Body>

Sample getDictionaryEntry Response

<soap:Body>

<getDictionaryEntry>

<DictionaryEntry>

<description></description>

<dictionaryType>S</dictionaryType>

<directionAllowed>A</directionAllowed>

<entryType>F</entryType>

<enumerations></enumerations>

<inUse>true</inUse>

<mobileDataType>6</mobileDataType>

<mobileLength>7</mobileLength>

<name>Odometer</name>

<xmlTag>odometer</xmlTag>

</DictionaryEntry>

</getDictionaryEntry>

</soap:Body>