API Message Reference

GC - Get Columns

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose Get Columns
Example CM:DE:GC\TDdefault\CY1\B1Demo\B2sa\B3sa\B5MobilesOIxyz
S A client requests the list of columns for a specified table or view available for the Mobiles table using data source Demo. The column information is returned in the Column Data [CB] message.
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.
B5 Table string false 1 80 The table used by the ODBC data source.
CN CampaignName string true (See Description) 1 80 From - V10.7.830 - Identifies the campaign (or linked campaign) by name. Either the CN or CY parameter must be passed.
CY CampaignIdentifier int true (See Description) 0 9999 A unique integer ID for the campaign, which can be extracted from the Status broadcast message. Either the CN or CY parameter must be passed .
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 true 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