cPanel API 2 Functions - Locale::get_encoding
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Description
This function retrieves a user's encoding.
We strongly recommend that you use the following UAPI function instead of this function:
-
Locale::get_attributes
— This function retrieves information about the user's current locale setting.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Locale&cpanel_jsonapi_func=get_encoding
For more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Retrieve character set encoding for the user.
$get_encoding = $cpanel->api2(
'Locale', 'get_encoding'
);
For more information, read our Guide to the LiveAPI System.
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# Retrieve character set encoding for the user.
my $get_encoding = $cpliveapi->api2(
'Locale', 'get_encoding',
);
For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our Deprecated cPanel Tag Usage documentation.
Command Line
cpapi2 --user=username Locale get_encoding
- You must URI-encode values.
-
username
represents your account-level username. -
You
must
run the
--user=username
option. -
For more information and additional output options, read our
Guide to cPanel API 2
documentation or run the
cpapi2 --help
command. -
If you run CloudLinux™, you
must
use the full path of the
cpapi2
command:/usr/local/cpanel/bin/cpapi2
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "get_encoding",
"data": [
{
"encoding": "utf-8"
}
],
"event": {
"result": 1
},
"module": "Locale"
}
}
Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
encoding |
integer | The authenticated user's character set encoding.
|
Any cPanel-supported character encoding. | utf-8 |
reason |
string | A reason for failure. This function only returns a |
A string that describes the error. | This is an error message. |
result |
Boolean | Whether the function succeeded.
|
|
1 |