API Module Extension searchExtensionRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 13:22, 1 February 2016

Module Extension > Search

Module	extension
Command name	searchExtensionRequest
Use	Returns a list of extension objects matching search criteria
Input	limit default value: 100, maximum value: 1000 offset default value: 0 onlyNames withDescription default value: 0 withPrice default value: 0 withUsageCount default value: 0
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

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?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>
            <isRransferAuthCodeRequired>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>

@@ Line 13: / Line 13: @@
 |'''Input'''
 |
-*limit ''default value: 100''
+*limit ''default value: 100, maximum value: 1000''
 *offset ''default value: 0''
 *onlyNames