Disabling LP¶
The disable operation is used to enable LP on the server. This operation is available on Linux only.
Note
You cannot disable the default language pack.
Request Packet Structure¶
A request XML packet disabling LP’s includes the disable operation node:
<packet version="1.5.0.0">
<locale>
<disable>
</disable>
</locale>
</packet>
The disable node is presented by type LocaleDisableInput
(locale.xsd
), and its graphical representation is as follows:
Note
The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.
- The filter node is required. Specifies the filtering rule. For
more information, refer to the Available Filters
section. Data type: LocaleFilter (
locale.xsd
) .
Response Packet Structure¶
The disable node of the output XML packet is presented by type
LocaleDisableOutput (locale.xsd
) and structured as follows:
Note
The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.
- The result node is required. It wraps the response retrieved
from the server. Data type: LocaleResultType (
locale.xsd
). - The status node is required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. It returns the error code if the operation fails. Data type: unsignedInt.
- The errtext node is optional. It returns the error message if the operation fails. Data type: string.
- The filter-id node is optional. It returns a filtering rule parameter. For more information, refer to the Available Filters section. Data type: anySimple.
- The id node is optional. It holds name of the language pack matched by the filtering rule. Data type: string.
Samples¶
Disabling a single LP¶
The following request packet disables French LP:
<packet>
<locale>
<disable>
<filter>
<id>fr-FR</id>
</filter>
</disable>
</locale>
</packet>
Response:
<packet>
<locale>
<disable>
<result>
<status>ok</status>
<filter-id>fr-FR</filter-id>
<id>fr-FR</id>
</result>
</disable>
</locale>
</packet>
If the LP was not found, the response from the server looks as follows:
<packet>
<locale>
<disable>
<result>
<status>error</status>
<errcode>1013</errcode>
<errtext>Locale does not exist</errtext>
<filter-id>fr-FR</filter-id>
<id>fr-FR</id>
</result>
</disable>
</locale>
</packet>
Disabling multiple LP’s¶
The following request packet disables French and Russian LP’s:
<packet>
<locale>
<disable>
<filter>
<id>fr-FR</id>
<id>ru-RU</id>
</filter>
</disable>
</locale>
</packet>
Response:
<packet>
<locale>
<disable>
<result>
<status>error</status>
<errcode>1013</errcode>
<errtext>Locale does not exist</errtext>
<filter-id>fr-FR</filter-id>
<id>en-US</id>
</result>
<result>
<status>ok</status>
<filter-id>ru-RU</filter-id>
<id>ru-RU</id>
</result>
</disable>
</locale>
</packet>