Personal tools

switchvox.localization.update

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Updates the localization setting for an admin.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
admin_id required integer The id of the admin whose localization setting you wish to update.
locale_code required string The new locale code to set for this admin. (en_us, en_gb, es_es, es_mx, and it_it are currently supported)


Example Requests & Responses

Please see the API Request and Response Format section for more information on various request encodings.

Example One

Request

Set admin with id of 1 to have a locale of en_gb. 

<request method="switchvox.localization.update">
    <parameters>
        <admin_id>1</admin_id>
        <locale_code>en_gb</locale_code>
    </parameters>
</request>

Response

Localization settings are successfully updated. 

<response method="switchvox.localization.update">
	<result>
		<success/>
	</result>
</response>

Error Codes

See the Error Code Formatting section to see the xml structure when an error is returned.
See the Generic Error Codes section to see a list of general fault codes that may be returned.
Code Description
97579 Invalid admin_id (%1). Admin_ids may only contain digits.
69143 Invalid locale code (%1).
Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.localization.update"