The get operation is used to retrieve information on installed extensions.

Request Packet Structure

A request XML packet retrieving information on installed extensions includes the get operation node:

<packet>
    <extension>
        <get/>
    </extension>
</packet>

• The filter node is  optional. It specifies the filtering rule. You can use the filter node only with the extension id element.

Response Packet Structure

• The result node is  required. It wraps the response retrieved from the server. Data type: resultType.
  • The status node is required. It specifies the execution status of the get operation. Allowed values: ok|error. Data type: string.
  • The errcode node is required if the get operation fails. It returns the error code. Data type: unsignedInt.
  • The errtext node is required if the get operation fails. It returns the error message. Data type: string.
  • The details node is required if the getoperation succeeds. It wraps the information about the retrieved extension.
    • The id node is required if the get operation succeeds. It returns the ID of the retrieved extension. Data type: string.
    • The name node is required if the get operation succeeds. It returns the name of the retrieved extension. Data type: string.
    • The version node is required if the get operation succeeds. It returns the version of the retrieved extension. Data type: string.
    • The release node is required if the get operation succeeds. It returns the release number of the retrieved extension. Data type: integer.
    • The active node is required if the get operation succeeds. It shows if the retrieved extension is enabled or disabled. Data type: boolean.

Samples

The following packet retrieves information on the installed extension with the given ID:

<packet>
    <extension>
        <get>
            <filter>
                <id>wp-toolkit</id>
            </filter>
        </get>
    </extension>
</packet>

Response:

<packet>
    <extension>
        <get>
            <result>
                <status>ok</status>
                <details>
                    <id>wp-toolkit</id>
                    <name>WP Toolkit</name>
                    <version>2.5.0</version>
                    <release>763</release>
                    <active>true</active>
                </details>
            </result>
        </get>
    </extension>
</packet>