exportLocales

Categoría	Metadata retrieval
Descripción	Devuelve una lista de todas las configuraciones regionales de una empresa.
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método solo contiene una etiqueta de credenciales
para identificar y autorizar al usuario que llama. Una vez verificado, el método devuelve un documento XML que describe el conjunto completo de todas las configuraciones regionales asociadas a esa empresa.

Formato de solicitud


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

elemento de credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la llamada a la API se lleve a cabo. correcta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio de sesión	Sí	El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método.	sampleuser@company.com
contraseña	Sí	La contraseña del usuario que invoca el método API.	my_password
configuración regional	No	Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de mes y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano).	fr_FR
instanceCode	No	Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning , este atributo se puede utilizar para especificar que el usuario tiene la intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances.	MYINSTANCE1
Contenido del elemento
(ninguno)

Formato de respuesta


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

elemento de respuesta
Nombre de etiqueta		respuesta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	Verdadero o falso, que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.	verdadero
obsoleto	No	Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o de la API que se está invocando ha quedado obsoleta y está oficialmente desaprobada. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente.	falso
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.

elemento de resultado
Nombre de etiqueta		salida
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Un solo elemento de atributos obligatorios. Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.

elemento de configuraciones regionales
Nombre de etiqueta	configuraciones regionales
Descripción	Contenedor para uno o varios elementos de configuración regional.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de configuración regional.

elemento de configuración regional
Nombre de etiqueta		configuración regional
Descripción		Representa una configuración regional única asociada a una empresa.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
código	Sí	El código de configuración regional estándar utilizado por Firefox.	es
nombre	Sí	Una versión legible del nombre de la configuración regional.	Inglés
isDefault	Sí	Si esta configuración regional es la predeterminada para la empresa, 1. De lo contrario, 0.	1
Contenido del elemento
(ninguno)