exportActiveCurrencies

Cette API prend uniquement en charge l'utilisateur Concept : règles d'accès dans API v22 et supérieure.

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées de la liste complète de toutes les devises configurées dans le système.
Autorisations requises pour appeler	Aucun (doit être des identifiants valides pour l'instance)
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient uniquement un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. Une fois vérifiée, la méthode renvoie un document XML décrivant l'ensemble complet de toutes les devises configurées dans le système. Une devise a été "configurée" une fois qu'elle a été ajoutée à la liste des devises dans Administration des devises, même si elle n'a pas encore de taux de change. Les instances pour lesquelles la fonctionnalité Multidevise 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 identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
se connecter	O	Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode.	sampleuser@company.com
mot de passe	O	Mot de passe de l'utilisateur appelant la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l'utilisateur spécifié dans les identifiants a accès à plusieurs instances de : Adaptive Planning , cet attribut peut être utilisé pour indiquer que l'utilisateur a l'intention d'accéder à une instance autre que son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

Format de la 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	O	Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.	vrai
obsolète	N	S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est officielement dépréciée. Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent.	false
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un é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 contient la sortie valide de tout appel d'API réussi.

élément 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 seule devise renvoyée dans la réponse à un appel d'API exportActiveCurrencies. Pour les versions antérieures à l'API v17, l'attribut ou les devises définis par l'utilisateur ne seront pas affichés.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant du système interne pour la devise. Ce nombre peut être utilisé pour identifier de manière unique la devise, mais n'est utilisé dans aucun autre appel d'API.	1
code	O	Code à trois lettres de la devise, tel que spécifié dans la norme ISO 4217.	USD
précision	O	Précision décimale classique (nombre de chiffres après la décimale) à utiliser pour afficher les montants exprimés dans cette devise. Cette précision est uniquement utilisée pour les comptes dont le type d'affichage est Devise et dont la précision décimale est définie sur "Utiliser la précision de la devise".	2
isReportingCurrency	O	Si la devise a été sélectionnée par un administrateur comme disponible pour une utilisation dans les conversions de rapport arbitraires. True=1, False=0.	1
userdéfini Disponible dans API v17 et supérieure	O	Si la devise a été créée par l'utilisateur ou non. True=1, False=0.	0
description	O	Description de base de la devise, comprenant le pays et le nom de la devise.	États-Unis d'Amérique, dollar
Contenu de l'élément
(aucun)