API Module Extension searchExtensionRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 46: Line 46:
===Raw XML===
===Raw XML===
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
-
  <openxml>
+
  <openXML>
   <credentials>
   <credentials>
     <username>username</username>
     <username>username</username>
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <searchextensionrequest>
+
   <searchExtensionRequest>
-
     <withusagecount>1</withusagecount>
+
     <withUsageCount>1</withUsageCount>
     <limit>3</limit>
     <limit>3</limit>
-
   </searchextensionrequest>
+
   </searchExtensionRequest>
-
  </openxml>
+
  </openXML>
   
   
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
-
  <openxml>
+
  <openXML>
   <reply>
   <reply>
-
     <code>0</code>
+
     < code>0</code>
     <desc></desc>
     <desc></desc>
     <data>
     <data>
Line 67: Line 67:
           <item>
           <item>
             <name>ac</name>
             <name>ac</name>
-
             <transferavailable>0</transferavailable>
+
             <transferAvailable>0</transferAvailable>
-
             <istransferauthcoderequired>0</istransferauthcoderequired>
+
             <isRransferAuthCodeRequired>0</isTransferAuthCodeRequired>
-
             <domicileavailable>0</domicileavailable>
+
             <domicileAvailable>0</domicileAvailable>
           </item>
           </item>
           <item>
           <item>
             <name>ae</name>
             <name>ae</name>
-
             <transferavailable>1</transferavailable>
+
             <transferAvailable>1</transferAvailable>
-
             <istransferauthcoderequired>1</istransferauthcoderequired>
+
             <isTransferAuthCodeRequired>1</isTransferAuthCodeRequired>
-
             <domicileavailable>0</domicileavailable>
+
             <domicileAvailable>0</domicileAvailable>
           </item>
           </item>
           <item>
           <item>
             <name>ag</name>
             <name>ag</name>
-
             <transferavailable>0</transferavailable>
+
             <transferAvailable>0</transferAvailable>
-
             <istransferauthcoderequired>1</istransferauthcoderequired>
+
             <isTransferAuthCodeRequired>1</isTransferAuthCodeRequired>
-
             <domicileavailable>0</domicileavailable>
+
             <domicileAvailable>0</domicileAvailable>
           </item>
           </item>
         </array>
         </array>
Line 88: Line 88:
     </data>
     </data>
   </reply>
   </reply>
-
  </openxml>
+
  </openXML>

Revision as of 13:50, 1 July 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>
    < 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>
Retrieved from "https://doc.openprovider.eu/API_Module_Extension_searchExtensionRequest"
Views
Personal tools