exportActiveCurrencies

Cette API prend en charge uniquement l’utilisateur Concept : règles d’accès dans l’API v22 et au-delà.

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées de la liste complète de toutes les devises qui ont été configurées dans le système.
Autorisations obligatoires pour pouvoir être appelées	Aucun (doit être un identifiant valide pour l’instance)
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient uniquement un marqueur d’identification pour désigner et autoriser l’utilisateur qui est auteur de l’appel. Une fois vérifiée, la méthode renvoie un document XML décrivant l’ensemble de toutes les devises qui ont été configurées dans le système. Une devise a été « configurée » une fois qu'elle a été ajoutée à la liste de devises dans l'administration des devises, même si elle n'a pas encore de taux de change. Les instances pour lesquelles la fonction Plusieurs devises n’est pas activée renvoient une seule devise dans cette liste.

Format de demande


<?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>

élément de données d'identification
Nom du marqueur		données d'identification
Description		Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté réussir.
Attributs de l'élément
Nom de l’attribut	Obligatoire ?	Valeur	Exemple
ouvrir une session	Y	Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode.	sampleuser@company.com
mot de passe	Y	Le mot de passe de l’utilisateur qui invoque la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les numéros et les dates entrants et pour mettre en forme les numéros et les dates sortants (à l’aide du séparateur des milliers, des noms de mois et du format de date appropriés). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de Adaptive Planning , cet attribut peut être utilisé pour préciser que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances disponibles, utilisez l’API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

Format de réponse


<?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>

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.	vrai
obsolète	N	S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée. Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent.	faux
Contenu de l'élément
Un seul élément de message facultatif et un seul élément de sortie obligatoire.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seul élément devises obligatoire. Ce filtre `de sortie` est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi.

élément de devises
Nom du marqueur		devises
Description		Conteneur pour un ou plusieurs éléments de devise.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future.
Contenu de l'élément
Un ou plusieurs éléments de devise.

élément de devise
Nom du marqueur		devise
Description		Représente une devise unique retournée en réponse à un appel d’API exportActiveCurrencies. Pour les versions antérieures à l’API v17, il n’affichera ni l’attribut défini par l’utilisateur ni les devises définies par l’utilisateur.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Il s’agit du numéro d’identifiant de système interne pour la devise. Ce nombre peut être utilisé pour désigner de manière unique la devise, mais n’est utilisé dans aucun autre appel d’API.	1
code	Y	Le code à trois lettres de la devise, comme le précise la norme ISO 4217.	utilisé
précision	Y	La précision décimale habituelle (nombre de chiffres après la décimale) à utiliser lors de l’affichage des montants dans cette devise. Cette précision n'est utilisée que pour les comptes qui ont un type d'affichage en Devise et dont la précision décimale est définie à « Utiliser la précision de la devise »	2
isReportingDevise	Y	Si la devise a été sélectionnée par un administrateur comme disponible pour une utilisation dans le cas de conversions de rapports arbitraires. True=1, False=0.	1
userDefined Disponible dans l'API v17+	Y	Que la devise ait été créée par l’utilisateur ou non. True=1, False=0.	0
description	Y	Description de base de la devise, comprenant le pays associé à la devise et son nom.	États-Unis d'Amérique, dollar
Contenu de l'élément
(aucun)