Get database details - GetListMetaData

Returns the description of an Acoustic Campaign database, query, or relational table.

Elements (Required)

LIST_ID - Numeric identifier for the entity Acoustic Campaign exports.

<Envelope>
  <Body>
    <GetListMetaData>
      <LIST_ID>59294</LIST_ID>
    </GetListMetaData>
  </Body>
</Envelope>
<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <ID>108220</ID>
      <NAME>Test3</NAME>
      <TYPE>0</TYPE>
      <SIZE>12</SIZE>
      <NUM_OPT_OUTS>0</NUM_OPT_OUTS>
      <NUM_UNDELIVERABLE>0</NUM_UNDELIVERABLE>
      <LAST_MODIFIED>02/02/06 04:51 PM</LAST_MODIFIED>
      <LAST_CONFIGURED>02/02/06 04:51 PM</LAST_CONFIGURED>
      <CREATED>02/02/06 04:51 PM</CREATED>
      <VISIBILITY>0</VISIBILITY>
      <USER_ID>12c734c-108b610e402-f528764d624db129b32c21fbca0cb8d6</USER_ID>
      <ORGANIZATION_ID>113cf49-fc61243b0b-f528764d624db129b32c21fbca0cb8d6 </ORGANIZATION_ID>
      <OPT_IN_FORM_DEFINED>false</OPT_IN_FORM_DEFINED>
      <OPT_OUT_FORM_DEFINED>true</OPT_OUT_FORM_DEFINED>
      <PROFILE_FORM_DEFINED>false</PROFILE_FORM_DEFINED>
      <OPT_IN_AUTOREPLY_DEFINED>false</OPT_IN_AUTOREPLY_DEFINED>
      <PROFILE_AUTOREPLY_DEFINED>false</PROFILE_AUTOREPLY_DEFINED>
      <COLUMNS>
        <COLUMN>
          <NAME>LIST_ID</NAME>
        </COLUMN>
        <COLUMN>
          <NAME>MAILING_ID</NAME>
        </COLUMN>
        <COLUMN>
          <NAME>RECIPIENT_ID</NAME>
        </COLUMN>
        <COLUMN>
          <NAME>EMAIL</NAME>
        </COLUMN>
        <COLUMN>
          <NAME>CRM Lead Source</NAME>
        </COLUMN>
        <COLUMN>
          <NAME>CAR_TYPE</NAME>
          <DEFAULT_VALUE>Hybrid</DEFAULT_VALUE>
          <TYPE>0</TYPE>
        </COLUMN>
      </COLUMNS>
      <KEY_COLUMNS>
        <COLUMN>
          <NAME>Email</NAME>
        </COLUMN>
      </KEY_COLUMNS>
    </RESULT>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful; False if not.

ID - Identifies the database ID.

NAME - The name of the database.

TYPE - The type of database.

SIZE - The number of contacts in the database.

NUM_OPT_OUTS - The number of contacts opted-out from the database.

NUM_UNDELIVERABLE - The number of undeliverable contacts.

LAST_MODIFIED - The date Acoustic Campaign last modified the database.

LAST_CONFIGURED - The date Acoustic Campaign last configured the database.

PARENT_DATABASE_ID - Parent database ID if the requested LIST_ID is not a database. If the LIST_ID is a database, an empty tag returns (for example, <PARENT_DATABASE_ID/>).

CREATED - The creation date for the database.

VISIBILITY - The visibility of the database: 0 (Private) or 1 (Shared).

USER_ID - The ID of the user who created the database.

ORGANIZATION_ID - The ID of the organization where the database was created.

OPT_IN_FORM_DEFINED - Specifies if an Opt-In form exists for the database. Values are True or False.

OPT_OUT_FORM_DEFINED - Specifies if an Opt-Out form exists for the database. Values are True or False.

PROFILE_FORM_DEFINED - Specifies if the Edit Profile form exists for the database. Values are True or False.

OPT_IN_AUTOREPLY_DEFINED - Specifies if an Opt-In auto-reply form exists for the database. Values are True or False.

PROFILE_AUTOREPLY_DEFINED - Specifies if the Edit Profile auto-reply form exists for the database. Values are True or False.

KEY_COLUMNS - One or more key columns of the database.

COLUMN - XML nodes that return the column name of system and custom fields in the database.

The remaining elements are children of COLUMN

NAME - The field name with the following valid values:

  • 1 - Yes/No
  • 2 - Numeric column
  • 3 - Date column
  • 4 - Time column
  • 5 - Country column
  • 6 - Select one
  • 8 - Segmenting
  • 9 - System (Used for defining the EMAIL field only)
  • 15 - SMS phone number
  • 16 - Phone number
  • 17 - Timestamp
  • 20 - Multi-select

DEFAULT_VALUE - Specifies the default value for custom fields. For a multi-select column, the default value is a semi-colon delimited list of values.

TYPE - Specifies the type of the custom field.

SELECTION_VALUES - A list of possible values when the column type is Selection or Multi-Select.
VALUE - A child element of SELECTION_VALUES that is a single value for a Selection or Multi-Selection column.