Il metodo DeleteList permette di cancellare una o più Liste in MailUp, e tutti i dati ad esse associati.
string DeleteList(string accessKey, int listId, string autoId)
Il metodo riceve in ingresso:
- accessKey: chiave di accesso ottenuta chiamando il metodo Login.
- listId: Identificativo della Lista di MailUp.
- autoId: Identificativo esterno che permette a MailUp di individuare se una lista è stata creata in un contesto automatizzato o meno. Per Microsoft Dynamics CRM corrisponde all'ORGUNIQUENAME.
I parametri autoId e listId possono essere utilizzati entrambi o alternativamente, per maggiori chiarimenti considerare i seguenti scenari:
- Se listId presenta un valore maggiore di zero, è cancellata la lista corrispondente all'identificativo indicato. Un eventuale valore fornito con autoId è ignorato.
- Se listId presenta un valore minore o uguale a zero e autoId un valore non vuoto, sono cancellate tutte le Liste associate all'identificativo esterno fornito da autoId.
Il metodo restituisce una stringa in formato XML come riportato di seguito:
L'XML definito avrà le seguenti caratteristiche:
-
- Un nodo radice <DeleteLists>.
- Un nodo <Lists>, contenuto nel nodo radice.
- Un nodo <List> che presenta l'attributo Id che conterrà l'identificativo numerico della Lista, cancellata.
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 <DeleteList>.
- Un nodo <Error>, contenuto nel nodo radice, che riporta il messaggio di errore.