exportActiveCurrencies

Questa API supporta solo l'utente Concetto: Regole di accesso nell'API v22 e versioni successive.

Categoria	Recupero dei metadati
Descrizione	Restituisce i metadati per l'elenco completo di tutte le valute configurate nel sistema.
Autorizzazioni necessarie per richiamare	Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene solo un tag di credenziali per identificare e autorizzare l'utente chiamante. Una volta verificato, il metodo restituisce un documento XML che descrive l'insieme completo di tutte le valute configurate nel sistema. Una valuta è stata "configurata" dopo essere stata aggiunta all'elenco di valute in Amministrazione valuta, anche se non ha ancora un tasso di cambio. Le istanze per le quali non è abilitata la funzionalità Valute multiple restituiscono una sola valuta in questo elenco.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportActiveCurrencies" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_pwd"/>
  </call>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio ?	Valore	Esempio
accedere	S	Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.	sampleuser@company.com
password	S	La password dell'utente che richiama il metodo API.	my_password
impostazioni internazionali	N	Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).	fr_FR
instanceCode	N	Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning , questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<currencies seqNo="42">
  <currency id="2" code="EUR"  precision="4" isReportingCurrency="0" userDefined="0" description="Euro Member Countries, Euro" />
  <currency id="3" code="EUR1" precision="4" isReportingCurrency="0" userDefined="1" description="User-defined Euro 1" />
  <currency id="1" code="USD" precision="2" isReportingCurrency="1" userDefined="0" description="United States of America, Dollars" />
</currencies>
</output>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
obsoleto	N	Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta. Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente.	falso
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento di valute obbligatorio. Questo wrapper `di output` è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento valute
Nome tag		valute
Descrizione		Contenitore per uno o più elementi valuta.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
seqNo Aggiunto nell'API v17 ma riservato per un utilizzo futuro.
Contenuto dell'elemento
Uno o più elementi valuta.

elemento valuta
Nome tag		valuta
Descrizione		Rappresenta una singola valuta restituita nella risposta a una chiamata all'API exportActiveCurrencies. Per le versioni precedenti all'API v17, non verrà visualizzato l'attributo definito dall'utente o le valute definite dall'utente.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID sistema interno per la valuta. Questo numero può essere utilizzato per identificare in modo univoco la valuta, ma non viene utilizzato in altre chiamate API.	1
codice	S	Il codice di tre lettere per la valuta, come specificato nello standard ISO 4217.	usd
precisione	S	Precisione decimale tipica (numero di cifre dopo la posizione decimale) da utilizzare quando si visualizzano gli importi in questa valuta. Questa precisione viene utilizzata solo per i conti che hanno il tipo di visualizzazione Valuta e la cui precisione decimale è impostata su "Utilizza la precisione della valuta".	2
isReportingCurrency	S	Se la valuta è stata selezionata da un amministratore come disponibile per l'utilizzo in "conversioni di report arbitrari". True=1, False=0.	1
userDefined Disponibile nell'API v17+	S	Se la valuta è stata creata dall'utente o meno. True=1, False=0.	0
descrizione	S	Descrizione di base della valuta, composta dal paese e dal nome della valuta.	Stati Uniti d'America, dollaro
Contenuto dell'elemento
(nessuno)