Il metodo GetFields permette di recuperare i Campi dati Utente (cioè la struttura dei campi anagrafici) configurati in MailUp. Questa funzione è utile per le applicazioni che, per integrarsi con MailUp, devono mappare la propria struttura dati sull'anagrafica di MailUp. La mappatura è da intendersi come un'operazione preliminare Una tantum in cui si configura l'importazione dei dati in MailUp.
string GetFields(string accessKey)
Il metodo riceve in ingresso il parametro accessKey: chiave di accesso ottenuta chiamando il metodo Login.
Il metodo restituisce una stringa in formato XML che riporta i nomi e gli identificativi dei Campi dati Utente.
- In caso di interrogazione positiva L'XML restituito presenta la seguente struttura:
L'XML definito avrà le seguenti caratteristiche:
-
- Un nodo radice <GetFields>.
- Un nodo <Fields>, contenuto nel nodo radice.
- Una serie di nodi <Field> uno per ogni Campo dati Utente configurato, contenuti nel nodo <Fields>. I nodi <Field> presenteranno gli attributi Name e Id. Il primo conterrà il nome del Campo dati Utente, il secondo l'indice.
Nel caso non siano configurati Campi dati Utente l'XML restituito presenterà il nodo <Fields> vuoto (privo di campi <Field>).
In caso di errori durante l'interrogazione L'XML restituito presenta la seguente struttura:
L'XML definito presenterà le seguenti caratteristiche:
-
- Un nodo radice <GetFields>.
- Un nodo <Error>, contenuto nel nodo radice, che riporta il messaggio di errore.
E' importante notare che in MailUp i Campi dati Utente sono sempre definiti di tipo stringa. Per questa ragione il metodo GetFields non restituisce i tipi dei Campi dati Utente.
Di seguito esempi di risposte del metodo GetFields per i vari casi sopra descritti: