Il metodo CreateList permette di creare una Lista in MailUp, utilizzando i valori di default previsti per le Liste.
Questo metodo è utilizzato nei casi in cui un applicativo esterno che gestisce più aziende/organizzazioni utilizza un'unica console MailUp. Un classico esempio di utilizzo è costituito dall'integrazione tra MailUp e Microsoft Dynamics CRM: con un'unica istanza di CRM ed una sola di MailUp si possono gestire più aziende: l'aggiunta di una nuova azienda è gestita totalmente sul CRM, il quale provvede a creare su MailUp un nuovo ambiente isolato, cioè una nuova lista.
Si raccomanda di limitare il numero di liste create, in caso contrario si potrebbe verificare un degrado delle prestazioni dell'intera console MailUp.
string CreateList(string accessKey, string name, string autoId)
Il metodo riceve in ingresso:
- accessKey: chiave di accesso ottenuta chiamando il metodo Login.
- name: Nome della Lista di MailUp.
- autoId: Identificativo che permette a MailUp di individuare se una lista è stata creata in un contesto automatizzato o meno. Per Microsoft Dynamics CRM corrisponde all'ORGUNIQUENAME. Se non valorizzato (null o stringa vuota), la lista non sarà associata ad una creazione automatica.
Il metodo restituisce una stringa in formato XML che riporta l'identificativo numerico univoco ed il GUID della Lista creata in MailUp.
L'XML definito avrà le seguenti caratteristiche:
-
- Un nodo radice <CreateLists>.
- Un nodo <Lists>, contenuto nel nodo radice.
- Un nodo <List> che presenta gli attributi Guid, Id e Name. Il primo conterrà il GUID della Lista, il secondo l'identificativo numerico della Lista, il terzo il nome della Lista fornito in ingresso al metodo.
In caso di errori durante la creazione della Lista l'XML restituito presenta la seguente struttura:
L'XML definito presenterà le seguenti caratteristiche:
- Un nodo radice <CreateList>.
- Un nodo <Error>, contenuto nel nodo radice, che riporta il messaggio di errore.
Il metodo CreateList si occuperà anche di creare la cartella su cui dovranno essere inviati via FTP i file CSV contenenti i dati degli Utenti da importare.