Get Macro List

Last updated
Save as PDF

getMacroList

This web service retrieves a list of basic information for all macro templates in QTRACS/Portal in the specified direction.

A macro template is a preformatted dynamic message with controlled content in QTRACS/Portal.
For more information about the use of macro templates in Text and Macro Messaging see the Text and Macro Messaging Concepts page.

MacroDefinition[] getMacroList(String companyId, String direction) 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 macros to retrieve.
                 Valid values are: "F" - forward macros
                                          "R" - return macros
                                          "A" - all macros

This web service does not return the macroItemList array which contains the macro body details. A call to the getMacro web service is required to obtain the additional label and field information.

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

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 macro direction specified.
007 Invalid list type specified.
008 Invalid company Id.

Sample getMacroList Request

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

<soap:Body>

<getMacroList>

<companyId>MYCOMPANY</companyId>

<direction>A</direction>

</getMacroList>

</soap:Body>

Sample getMacroList Response

<soap:Body>

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

<macro xmlns="">

<assocRtnMac>16</assocRtnMac>

<definitionStatus>0000</definitionStatus>

<description>Load Assignment</description>

<direction>F</direction>

<macroItemList></macroItemList>

<msgSupr>false</msgSupr>

<name>Load Assignment</name>

<number>1</number>

<routeCoverage>true</routeCoverage>

<rtnMacCoverage></rtnMacCoverage>

<usage>0</usage>

<version>7</version>

</macro>

<macro xmlns="">

<assocRtnMac>16</assocRtnMac>

<definitionStatus>0000</definitionStatus>

<description>Load Stop Info</description>

<direction>F</direction>

<macroItemList></macroItemList>

<msgSupr>false</msgSupr>

<name>Load Stop Info</name>

<number>2</number>

<routeCoverage>true</routeCoverage>

<rtnMacCoverage></rtnMacCoverage>

<usage>9</usage>

<version>56</version>

</macro>

<macro xmlns="">

<assocRtnMac>0</assocRtnMac>

<definitionStatus>PEND</definitionStatus>

<description>Yard Check Reply</description>

<direction>R</direction>

<macroItemList></macroItemList>

<msgSupr>false</msgSupr>

<name>Yard Check</name>

<number>20</number>

<routeCoverage>true</routeCoverage>

<rtnMacCoverage>ROMANOWSKI</rtnMacCoverage>

<usage>2</usage>

<version>21</version>

</macro>

<macro xmlns="">

<assocRtnMac>0</assocRtnMac>

<definitionStatus>0000</definitionStatus>

<description>Request Time Off</description>

<direction>R</direction>

<macroItemList></macroItemList>

<msgSupr>false</msgSupr>

<name>Rqt Time Off</name>

<number>21</number>

<routeCoverage>false</routeCoverage>

<rtnMacCoverage>ROMANOWSKI</rtnMacCoverage>

<usage>27</usage>

<version>20</version>

</macro>

</getMacroList>

</soap:Body>