API Message Reference

GT - Get Tables

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose Get Tables
Example CM:DE:GT\TDdefault\CY1\B1Demo\B2sa\B3sa\OIxyz
Explanation A client requests the list of tables and views available for data source 'Demo'. The table data is returned in the Table Data [TB] message.
Notes See RouterNET Integration. See also SDMP Message Protocol
Parameters
Code Name Type Mandatory? Min Val Max Val Description
B1 DataSourceName string true 1 80 The name of the ODBC data source.
B2 DataSourceUser string false 1 80 The user id to log on to the ODBC data source.
B3 DataSourcePassword string false 1 80 The password for the ODBC data source.
B4 Schema string false 1 80 The schema used by the ODBC data source.
CY CampaignIdentifier int true 0 9999 Campaign Identifier parameter. The identifier can be extracted from the status broadcast message.
OI OriginatorID string true 1 255 Originator ID. A token identifying the originator of the message.

The Originator ID (OI) parameter does not need to be specified if using the RouterNet method and event API. RouterNet appends the Originator ID by default.

TD TenantDescriptor string true 1 80 Mandatory when operating in Multi-Tenancy. Otherwise it must not be used.

This parameter is alphanumeric and identifies to which tenant this message applies. Typically contains a company name.

TK Token string false 1 80 Token parameter
TX TransactionIdentifier string true 1 87 From V10.7.1025 - Transaction identifier uniquely identifying this request.

 

Copyright © 2004 - 2019  Sytel Limited