...
...
...
...
...
...
...
...
...
...
...
| Note | ||
|---|---|---|
| ||
The response of DeleteListmethod is different from many other MailUpSend methods because it includes "errorCode" only when call is not successful. If this inconsistency is critical for your client application you can use DeleteList_st method instead. DeleteList_st is the recommended choice if you are starting a new integration with MailUp. |
Method parameters
DeleteList method allows to delete one or more lists in MailUp, with all the related data.
- string DeleteList(string accessKey, int listId, stringautoId)
...
- 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.
...
- 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.
...
- 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.
...
- Un nodo radice <DeleteList>.
- Un nodo <Error>, contenuto nel nodo radice, che riporta il messaggio di errore.
...
- accessKey: access key obtained using the LoginFromId method
- listId: list identifier
- autoId: identifier which allows MailUp to know if a list was created in an automated context or not. In the Microsoft Dynamics CRM it corresponds to the ORGUNIQUENAME.
Parameters autoId e listId can be used together or alternatively; the following scenarios are possible:
- If listId value > 0, the corresponding list is deleted. Values provided via autoId are ignored.
- If listId value =< 0 and autoId is defined, all the lists associated to the external identifier provided via autoId are deleted.
Sample DeleteList response
| Code Block | ||||
|---|---|---|---|---|
| ||||
<DeleteList>
<Lists>
<List Id ="X"/>
</Lists>
</DeleteList > |
The XML string will have the following features:
- A root node <DeleteLists>.
- A node <Lists>, contained in the root node.
- A node <List> with the Id attribute containing the identifier of the deleted list
In case of errors during the creation of the list, the XML will have the following structure:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<DeleteList>
<Error>"Messaggio di errore"</Error>
</DeleteList > |
The XML string will have the following features:
- A root node <DeleteList>.
- A node <Error>, contained in the root node, returning the error message.