Enabling LP

The enable operation is used to enable LP on the server. This operation is available on Linux only.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet enabling LP's includes the enable operation node:

<packet version="1.5.0.0">
<locale>
   <enable>
   …
   </enable>
</locale>
</packet>

 

The enable node is presented by type LocaleEnableInput (locale.xsd), and its graphical representation is as follows:

  • 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 enable node of the output XML packet is presented by type LocaleEnableOutput (locale.xsd) and structured as follows:

  • 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

Enabling a single LP

The following request packet enables French LP:

<packet>
  <locale>
    <enable>
        <filter>
        <id>fr-FR</id>
        </filter>
    </enable>
  </locale>
</packet>

Response:

<packet>
  <locale>
    <enable>
      <result>
        <status>ok</status>
        <filter-id>fr-FR</filter-id>
        <id>fr-FR</id>
      </result>
    </enable>
  </locale>
</packet>

 

If the LP was not found, the response from the server looks as follows:

<packet>
  <locale>
    <enable>
      <result>
        <status>error</status>
        <errcode>1013</errcode>
        <errtext>Locale does not exist</errtext>
        <filter-id>fr-FR</filter-id>
        <id>fr-FR</id>
      </result>
    </enable>
  </locale>
</packet> 
Enabling multiple LP's

The following request packet enables French and Russian LP's:

<packet>
  <locale>
    <enable>
        <filter>
          <id>fr-FR</id>
          <id>ru-RU</id>
        </filter>
    </enable>
  </locale>
</packet>

Reponse:

<packet>
  <locale>

    <enable>
      <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>
    </enable>
  </locale>
</packet>

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.