Overview

Skill Level: Any

Prerequisites

This interface extracts a list of databases for an organization.

Step-by-step

  1. Syntax of the request and response SOAP for GetLists

    Operation <GetLists>       
    Elements VISIBILITY 

    Required. Defines the visibility of the databases to return.

    0 ‚Äď Private

    1 ‚Äď Shared¬†

       
      LIST_TYPE 

    Defines the type of entity to return. Supported values are:

    0 ‚Äď Databases

    1 ‚Äď Queries

    2 ‚Äď Both Databases and Queries

    5 ‚Äď Test Lists

    6 ‚Äď Seed Lists

    13 ‚Äď Suppression Lists

    15 ‚Äď Relational Tables

    18 ‚Äď Contact Lists

     

       
      FOLDER_ID  Optional parameter to specify a particular folder from which to return databases.     
      INCLUDE_ALL_LISTS 

    Optional parameter to specify that Watson Campaign Automation return all databases within subfolders. Valid
    values are True and False.

    Note: Watson Campaign Automation will ignore the FOLDER_ID element if set to True. 

       
      INCLUDE_TAGS  Optional parameter to return all Tags associated with the database.     
    Example¬† <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:sil=”SilverpopApi:EngageService.SessionHeader”
    xmlns:sil1=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <soapenv:Header>
    <sil:sessionHeader>
    <sil:sessionid>C28F46937CD55F61A767FF5E99A022EC</sil:sessionid>
    </sil:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <sil1:GetLists>
    <sil1:VISIBILITY>1</sil1:VISIBILITY>
    <sil1:LIST_TYPE>2</sil1:LIST_TYPE>
    </sil1:GetLists>
    </soapenv:Body>
    </soapenv:Envelope> 
         
    Response  <RESULT>       
    Elements  SUCCESS  True if successful.     
      LIST  XML nodes defining each database.     
      Child Element  ID  Returns the unique ID of the entity.   
        NAME  Returns the name of the entity.   
        TYPE 

    Returns the type. Possible values are:
    0-Databases

    1 ‚Äď Queries

    2 ‚Äď Both Databases and Queries

    5 ‚Äď Test Lists

    6 ‚Äď Seed Lists

    13 ‚Äď Suppression Lists

    15 ‚Äď Relational Tables¬†

     
        SIZE  Returns the number of contacts in the database.   
    ¬† ¬† NUM_OPT_OUTS¬† Returns the number of opted‚Äźout contacts in the database.¬† ¬†
        NUM_UNDELIVERABLE  Returns the number of undeliverable contacts in the database.   
        LAST_MODIFIED  Returns the date and time when the database was last
    modified. 
     
        VISIBILITY  Returns the visibility of the database (for example, Shared or
    Private). 
     
        PARENT_NAME  Returns the name of the associated parent folder.   
        USER_ID  Returns the User ID for the database owner.   
        PARENT_FOLDER_ID  Returns the ID of the folder within which the database resides.   
        IS_FOLDER  Returns True if the entity is a folder rather than a database,
    query, or relational table. 
     
        Tags  If INCLUDE_TAGS is specified in the request, returns any tags
    associated with the database. 
     
          Tag  XML nodes containing the Tags
    associated with the database. 
    Example <envelope:Envelope xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body xmlns=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <RESULT>
    <SUCCESS>true</SUCCESS>
    <LIST>
    <ID>17383</ID>
    <NAME>ATestFolder</NAME>
    <TYPE>0</TYPE>
    <SIZE>0</SIZE>
    <NUM_OPT_OUTS>0</NUM_OPT_OUTS>
    <NUM_UNDELIVERABLE>0</NUM_UNDELIVERABLE>
    <LAST_MODIFIED>05/14/08 04:10 PM</LAST_MODIFIED>
    <VISIBILITY>1</VISIBILITY>
    <PARENT_NAME/>
    <USER_ID>19c2347‚Äź11929e0fe49‚Äź3652cd0ad7b4125d323423bf450b7c72</USER_ID>
    <PARENT_FOLDER_ID>4085</PARENT_FOLDER_ID>
    <IS_FOLDER>true</IS_FOLDER>
    <FLAGGED_FOR_BACKUP>false</FLAGGED_FOR_BACKUP>
    <SUPPRESSION_LIST_ID>0</SUPPRESSION_LIST_ID>
    <SUPPRESSION_LIST_ID>0</SUPPRESSION_LIST_ID>
    </LIST>
    <LIST>
    <ID>82537</ID>
    <NAME>CW</NAME>
    <TYPE>1</TYPE>
    <SIZE>0</SIZE>
    <NUM_OPT_OUTS>0</NUM_OPT_OUTS>
    <NUM_UNDELIVERABLE>0</NUM_UNDELIVERABLE>
    <LAST_MODIFIED>02/01/10 11:41 AM</LAST_MODIFIED>
    <VISIBILITY>1</VISIBILITY>
    <PARENT_NAME/>
    <USER_ID>4b695b‚Äź12647e94a9b‚Äź6daca699e65990d0e2d42de841d44e31</USER_ID>
    <PARENT_FOLDER_ID>4085</PARENT_FOLDER_ID>
    <IS_FOLDER>true</IS_FOLDER>
    <FLAGGED_FOR_BACKUP>false</FLAGGED_FOR_BACKUP>
    <SUPPRESSION_LIST_ID>0</SUPPRESSION_LIST_ID>
    <SUPPRESSION_LIST_ID>0</SUPPRESSION_LIST_ID>
    </LIST>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope>
         

Join The Discussion

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