Overview

Skill Level: Any

Step-by-step

  1. Syntax of the request and response XML for GetListMetaData

    Operation <GetListMetaData>
    Elements LIST_ID Numeric identifier for the entity theAcoustic Campaign is exporting.
    Example
    <Envelope>
      <Body>
        <GetListMetaData>
          <LIST_ID>59294</LIST_ID>
        </GetListMetaData>
      </Body>
    </Envelope>
    Response <RESULT>
    Elements SUCCESS True if successful.
      ID Identifies the database ID.
      NAME Returns the name of the database.
      TYPE Returns the type of database.
      SIZE Returns the number of contacts in the database.
      NUM_OPT_OUTS Returns the number of contacts opted-out from the database.
      NUM_UNDELIVERABLE Returns the number of undeliverable contacts.
      LAST_MODIFIED Returns the date the Acoustic Campaign last modified the database.
      LAST_CONFIGURED Returns the date the Acoustic Campaign last configured the database.
      PARENT_DATABASE_ID Returns Parent database ID if LIST_ID in request is not a database. If the LIST_ID in request is a database, an empty tag, (for example, <PARENT_DATABASE_ID/>) is returned.
      CREATED Returns the creation date for the database.
      VISIBILITY Returns the visibility of the database. Valid values are:

    • 0 – Private
    • 1 – Shared
      USER_ID Returns the ID of the user who created the database.
      ORGANIZATION_ID Returns the ID of the Organization within which the database was created.
      OPT_IN_FORM_DEFINED Specifies whether an Opt-In form exists for the database. Values are True or False.
      OPT_OUT_FORM_DEFINED Specifies whether an Opt-Out form exists for the database. Values are True or False.
     

    PROFILE_FORM_DEFINED

    Specifies whether Edit Profile form exists for the database. Values are True or False.
      OPT_IN_AUTOREPLY_DEFINED Specifies whether an Opt-In Auto-reply form exists for the database. Values are True or False.
      PROFILE_AUTOREPLY_DEFINED Specifies whether Edit Profile Auto-reply form exists for the database. Values are True or False.
      KEY_COLUMNS Returns one or more Key Columns of the database.
    ChildElements Optional COLUMN XML nodes that return the column name of system and custom fields in the database.
        ChildElements NAME Specifies the field name.
          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 custom field. The following is a list of valid values:

    • 1 – YESNO
    • 2 – Numeric column
    • 3 – Date column
    • 4 – Time column
    • 5 – Country column
    • 6 – Select one
    • 8 – Segmenting
    • 9 – System (used for defining EMAIL field only)
    • 15 – SMS Phone Number
    • 16 – Phone Number
    • 17 – Timestamp
    • 20 – Multi-Select
        SELECTION_VALUES Optional A list of possible values when column type is Selection or Multi-Select.
        Child Elements VALUE A single value for a Selection or Multi-Select column.
    Example
    <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>

2 comments on"Get database details"

  1. How do you get this to include all the email in the list?

    • Hello Johnny,
      Have you used the following in your call?

      EMAIL

      If yes, did that work for you or no?

      Thank you
      Jeri

Join The Discussion

Your email address will not be published. Required fields are marked *