Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

...

...

...

...

...

...

...

...

...

Note
titleDEPRECATED METHOD

The response of GetListIdentity method 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 GetListIdentity_st method instead. GetListIdentity_st is the recommended choice if you are starting a new integration with MailUp.

 

Method parameters

GetListIdentity allows to retrieve the identifiers of a list in MailUp, starting from an external ID. When integrating with Microsoft Dynamics CRM, the identifier is ORGUNIQUENAME. 

  • string GetListIdentity(string accessKey, string string autoId)
    • accessKey:
    chiave di accesso ottenuta chiamando il metodo Login.
    •  access key obtained using the LoginFromId method
    • autoId:
    Identificativo creato esternamente a MailUp, che permette a di individuare se una lista è stata creata in un contesto automatizzato o meno. Per Microsoft Dynamics CRM corrisponde all'ORGUNIQUENAME.

...

  • Un nodo radice <GetListIdentity>
    • 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.

...

  • Un nodo radice <GetListIdentity>.
  • Un nodo <Error>, contenuto nel nodo radice, che riporta il messaggio di errore
    •  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.

Sample GetListIdentity response

The method returns a string in XML format containing the list identifier and the GUID of the List created in the MailUp console.

Code Block
languagehtml/xml
linenumberstrue
<GetList>

       <Lists>

<List Guid="Guid" Id ="X" Name="nome"/>

       </Lists>

</GetList>


The XML string will have the following features:

  • A root node <GetListIdentity>
  • A node <Lists>, contained in the root node.
  • A node <List> with the attributes GuidId e Name. These contain respectively the GUID of the list, the ID of the list and the name of the list provided at entrance, 


In case of errors during the creation of the list, the XML will have the following structure:

Code Block
languagehtml/xml
linenumberstrue
<GetListIdentity>

<Error>"Messaggio di errore"</Error>

</GetListIdentity>


The XML string will have the following features:

  • A root node <GetListIdentity>.
  • A node <Error>, contained in the root node, returning the error message.