This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

Go to the new documentation

API Module Extension searchExtensionRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Extension > Search== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |extension |- style="background-color:#EEEEEE;" |'''Command name'''…')
Line 37: Line 37:
==Examples==
==Examples==
===Using PHP class===
===Using PHP class===
-
  to do
+
  $request = new OP_Request;
 +
$request->setCommand('searchExtensionRequest')
 +
  ->setAuth(array('username' => 'username', 'password' => 'password'))
 +
  ->setArgs(array(
 +
    'withUsageCount' => true
 +
  ));
===Raw XML===
===Raw XML===
-
  to do
+
  <?xml version="1.0" encoding="UTF-8"?>
 +
<openxml>
 +
  <credentials>
 +
    <username>username</username>
 +
    <password>password</password>
 +
  </credentials>
 +
  <searchextensionrequest>
 +
    <withusagecount>1</withusagecount>
 +
    <limit>3</limit>
 +
  </searchextensionrequest>
 +
</openxml>
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openxml>
 +
  <reply>
 +
    <code>0</code>
 +
    <desc></desc>
 +
    <data>
 +
      <results>
 +
        <array>
 +
          <item>
 +
            <name>ac</name>
 +
            <transferavailable>0</transferavailable>
 +
            <istransferauthcoderequired>0</istransferauthcoderequired>
 +
            <domicileavailable>0</domicileavailable>
 +
          </item>
 +
          <item>
 +
            <name>ae</name>
 +
            <transferavailable>1</transferavailable>
 +
            <istransferauthcoderequired>1</istransferauthcoderequired>
 +
            <domicileavailable>0</domicileavailable>
 +
          </item>
 +
          <item>
 +
            <name>ag</name>
 +
            <transferavailable>0</transferavailable>
 +
            <istransferauthcoderequired>1</istransferauthcoderequired>
 +
            <domicileavailable>0</domicileavailable>
 +
          </item>
 +
        </array>
 +
      </results>
 +
      <total>117</total>
 +
    </data>
 +
  </reply>
 +
</openxml>

Revision as of 04:28, 16 April 2010

Contents

Module Extension > Search

Module extension
Command name searchExtensionRequest
Use Returns a list of extension objects matching search criteria
Input
  • limit
  • offset
  • onlyNames
  • withDescription
  • withPrice
  • withUsageCount
Output Result set of extension details:
  • name
  • transferAvailable
  • isTransferAuthCodeRequired
  • domicileAvailable
  • usageCount
  • description
  • prices
  • isAuthorizationCodeRequired
  • isLockingAllowed
  • isTradeAllowed
  • restorePrice

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchExtensionRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'withUsageCount' => true
  ));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openxml>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchextensionrequest>
    <withusagecount>1</withusagecount>
    <limit>3</limit>
  </searchextensionrequest>
</openxml>

<?xml version="1.0" encoding="UTF-8"?>
<openxml>
  <reply>
    0
    <desc></desc>
    <data>
      <results>
        <array>
          <item>
            <name>ac</name>
            <transferavailable>0</transferavailable>
            <istransferauthcoderequired>0</istransferauthcoderequired>
            <domicileavailable>0</domicileavailable>
          </item>
          <item>
            <name>ae</name>
            <transferavailable>1</transferavailable>
            <istransferauthcoderequired>1</istransferauthcoderequired>
            <domicileavailable>0</domicileavailable>
          </item>
          <item>
            <name>ag</name>
            <transferavailable>0</transferavailable>
            <istransferauthcoderequired>1</istransferauthcoderequired>
            <domicileavailable>0</domicileavailable>
          </item>
        </array>
      </results>
      <total>117</total>
    </data>
  </reply>
</openxml>
Retrieved from "https://doc.openprovider.eu/API_Module_Extension_searchExtensionRequest"
Views
Personal tools