export Locales

Catégorie	Metadata retrieval
Description	Renvoie une liste de tous les paramètres régionaux d'une unité légale.
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 des paramètres régionaux associés à l'unité légale.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportLocales" 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>
         <locales>
             <locale code="en" name="English" isDefault="1" />
             <locale code="de" name="German" isDefault="0" />
             <locale code="fr" name="French" isDefault="0" />
             <locale code="es" name="Spanish" isDefault="0" />
             <locale code="pt" name="Portuguese" isDefault="0" />
             <locale code="nl" name="Dutch" isDefault="0" />
             <locale code="ja" name="Japanese" isDefault="0" />
         </locales>
     </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 dans 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
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un seul élément attributs obligatoires. 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 paramètres régionaux
Nom du marqueur	paramètres régionaux
Description	Conteneur pour un ou plusieurs éléments régionaux.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments régionaux.

élément de paramètres régionaux
Nom du marqueur		paramètres régionaux
Description		Représente un seul paramètre régional associé à une unité légale.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
code	O	Le code de paramètres régionaux standard tel qu'il est utilisé par Firefox.	fr
nom	O	Une version lisible du nom des paramètres régionaux.	Anglais
isDefault	O	Si ces paramètres régionaux sont les paramètres régionaux par défaut de l'unité légale, alors 1. Sinon, 0.	1
Contenu de l'élément
(aucun)