Get Macro Extended

Last updated
Save as PDF

getMacroEx

The getMacroEx web service is an extended version of getMacro that returns additional data.

MacroDefinitionEx getMacroEx(String direction, int number) 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.
direction: A String that specifies the direction of the macro to retrieve.
Valid values are: "F" - forward macro
"R" - return macro
number: An integer value that specifies the number of the macro to retrieve.
Valid values are: 1-63

For specific information about the MacroDefinitionEx object returned by this web service, see the Macro Definition Extended 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

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

Exceptions

002 Required field not specified.
003 Authenticated company not specified.
004 Authenticated user not specified.
005 User is not authorized.
006 Invalid macro direction specified.
007 Invalid macro number specified.
008 Specified macro does not exist.
009 Invalid company id.

Sample getMacroEx Request

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

<soap:Body>

<getMacroEx>

<companyId>MYCOMPANY</companyId>

<direction>R</direction>

<number>1</number>

</getMacroEx>

</soap:Body>

Sample getMacroEx Response

<soapenv:Body>

<getMacroExResponse>

<getMacroExReturn>

<macroItemList>

<MacroItemEx>

<description xsi:nil="true"/>

<dictionaryType xsi:nil="true"/>

<directionAllowed xsi:nil="true"/>

<entryType xsi:nil="true"/>

<enumerations xsi:nil="true"/>

<inUse>0</inUse>

<mobileDataType>0</mobileDataType>

<mobileLength>0</mobileLength>

<column>1</column>

<dictName/>

<dictTag/>

<groupName/>

<groupNum>0</groupNum>

<groupTag/>

<length>0</length>

<required>0</required>

<row>1</row>

<type>label</type>

<value>Message Time</value>

</MacroItemEx>

<MacroItemEx>

<description>Auto Timestamp</description>

<dictionaryType>C</dictionaryType>

<directionAllowed>R</directionAllowed>

<entryType>F</entryType>

<enumerations/>

<inUse>1</inUse>

<mobileDataType>24</mobileDataType>

<mobileLength>24</mobileLength>

<column>14</column>

<dictName>Auto Timestamp</dictName>

<dictTag>autoTime</dictTag>

<groupName/>

<groupNum>0</groupNum>

<groupTag/>

<length>24</length>

<required>0</required>

<row>1</row>

<type>field</type>

<value xsi:nil="true"/>

</MacroItemEx>

<MacroItemEx>

<description xsi:nil="true"/>

<dictionaryType xsi:nil="true"/>

<directionAllowed xsi:nil="true"/>

<entryType xsi:nil="true"/>

<enumerations xsi:nil="true"/>

<inUse>0</inUse>

<mobileDataType>0</mobileDataType>

<mobileLength>0</mobileLength>

<column>1</column>

<dictName/>

<dictTag/>

<groupName/>

<groupNum>0</groupNum>

<groupTag/>

<length>0</length>

<required>0</required>

<row>2</row>

<type>label</type>

<value>Location</value>

</MacroItemEx>

<MacroItemEx>

<description>Auto Location</description>

<dictionaryType>C</dictionaryType>

<directionAllowed>R</directionAllowed>

<entryType>F</entryType>

<enumerations/>

<inUse>1</inUse>

<mobileDataType>35</mobileDataType>

<mobileLength>25</mobileLength>

<column>10</column>

<dictName>Auto Location</dictName>

<dictTag>autoLocation</dictTag>

<groupName/>

<groupNum>0</groupNum>

<groupTag/>

<length>25</length>

<required>0</required>

<row>2</row>

<type>field</type>

<value xsi:nil="true"/>

</MacroItemEx>

</macroItemList>

<assocRtnMac>0</assocRtnMac>

<definitionStatus>0000</definitionStatus>

<description>Auto timestamp</description>

<direction>R</direction>

<msgSupr>0</msgSupr>

<name>Auto time</name>

<number>1</number>

<routeCoverage>1</routeCoverage>

<rtnMacCoverage/>

<usage>6</usage>

<version>5</version>

</getMacroExReturn>

</getMacroExResponse>

</soap:Body>

</soap:Envelope>