exportLocales

最後の更新
PDFとして保存

Category	Metadata retrieval
Description	Returns a list of all the locales for a company.
Parameters Required On Request	Credentials

This method's request contains only a credentials tag to identify and authorize the calling user. Once verified, the method returns an XML document describing the complete set of all locales associated with that company.

Request Format

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

credentials element
Tag Name		credentials
Description		All API calls must contain a single credentials element to identify the user invoking the API. The API call is then performed as this user (any audit trail or history of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to perform the action in order for the API call to succeed.
Attributes of the Element
Attribute Name	Required?	Value	Example
login	Y	The login name of the user invoking the API method. This user must have a role containing the permissions required for the method being invoked.	sampleuser@company.com
password	Y	The password of the user invoking the API method.	my_password
locale	N	Specify the locale to be used to interpret incoming numbers and dates, and to format outgoing numbers and dates (using the proper thousands separator, month names, and date formatting). The locale is also used to specify the language in which any system messages in the response should appear. If not specified, en_US (American English) is used.	fr_FR
instanceCode	N	If the user specified in the credentials has access to more than one instance of Adaptive Planning, this attribute can be used to specify that the user is intending to access an instance other than their default instance. If not speci- fied, the user's default instance will be used. To determine the available instance codes, use the exportInstances API.	MYINSTANCE1
Contents of the Element
(none)

Response Format

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

response element
Tag Name		response
Attributes of the Element
Attribute Name	Required?	Value	Example
success	Y	Either true or false, indicating whether the API call was successful or not. Even successful calls may contain warning messages in their response.	true
obsolete	N	If present on the response tag and set to true, this attribute indicates that the version of the method or API which is being invoked has become obsolete and is officially deprecated . While it continues to function at this time, it may cease functioning in a short while. Typically, this attribute is not present.	false
Contents of the Element
A single optional messages element, and exactly one required output element.

output element
Tag Name		output
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
A single required attributes element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call.

locales element
Tag Name	locales
Description	Container for one or more locale elements.
Attributes of the Element
Attribute name	Required?	Value	Example
(none)
Contents of the Element
One or more locale elements.

locale element
Tag Name		locale
Description		Represents a single locale associated with a company.
Attributes of the Element
Attribute Name	Required?	Value	Example
code	Y	The standard locale code as used by Firefox.	en
name	Y	A readable version of the name of the locale.	English
isDefault	Y	If this locale is the default for the company, then 1. Otherwise, 0.	1
Contents of the Element
(none)