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.

API Module Customer modifyCustomerRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Raw XML)
 
(6 intermediate revisions not shown)
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*'''handle'''
+
*'''[[API Format Handle|handle]]''' (customer unique identifier or customer [[API Format Handle|handle]])
*vat
*vat
*'''[[API Format Address|address]]'''
*'''[[API Format Address|address]]'''
Line 20: Line 20:
*'''email'''
*'''email'''
*[[API Format Additional Data Customer|additionalData]]
*[[API Format Additional Data Customer|additionalData]]
-
*[[API Format Extensions Additional Data Customer|extensionAdditionalData]]
+
*[[API Format Extensions Additional Data Customer|extensionAdditionalData]] (NB! Mandatory for some TLDs)
 +
*[[API Format locale|locale]]
*[[API Format tags|tags]]
*[[API Format tags|tags]]
|- style="vertical-align:top;"
|- style="vertical-align:top;"
Line 94: Line 95:
   </credentials>
   </credentials>
   <modifyCustomerRequest>
   <modifyCustomerRequest>
-
     <name>
+
     <handle>JD911740-ES</handle>
-
      <initials>J.D</initials>
+
-
      <firstName>John</firstName>
+
-
      <lastName>Doe</lastName>
+
-
    </name>
+
-
    <gender>M</gender>
+
     <address>
     <address>
       <street>Castellano</street>
       <street>Castellano</street>
Line 114: Line 110:
     </phone>
     </phone>
     <email>myemail@gmail.com</email>
     <email>myemail@gmail.com</email>
-
    <handle>JD911740-ES</handle>
 
   </modifyCustomerRequest>
   </modifyCustomerRequest>
  </openXML>
  </openXML>
Line 121: Line 116:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     < code>0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc></desc>
     <desc></desc>
   </reply>
   </reply>
  </openXML>
  </openXML>

Current revision as of 08:07, 29 August 2019

Contents

Module Customer > Modify

Module customer
Command name modifyCustomerRequest
Use Changes the data of an existing customer object
Input
Output

-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('modifyCustomerRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'handle' => 'AJ001927-NL',

   'phone' => array(
     'countryCode' => '+31',
     'areaCode' => '10',
     'subscriberNumber' => '4482299'
   ),

   'fax' => array(
     'countryCode' => '+31',
     'areaCode' => '10',
     'subscriberNumber' => '2440250'
   ),

   'address' => array(
      'street' => 'Nieuwe Binnenweg',
      'number' => '137',
      'suffix' => 'a',
      'zipcode' => '3014 GJ',
      'city' => 'Rotterdam',
      'state' => 'Zuid-Holland',
      'country' => 'NL',
   ),

   'email' => 'support@openprovider.nl',

   'additionalData' => array(
     'birthCity' => 'Amsterdam',
     'birthDate' => '1971-02-14',
     'socialSecurityNumber' => '771268635',
     'companyRegistrationNumber' => '115372'
   ),
   'extensionAdditionalData' => array(
     array(
      'name' => 'pro',
      'data' => array(
        'profession' => 'software developer',
        'authorityName' => 'openprovider',
        'licenseNumber' => '12345678',
        'authorityUrl' => 'http://openprovider.com'
       )
     ),
     array(
      'name' => 'jobs',
      'data' => array(
       'website' => 'http://openprovider.com'
      )
     )
   ),
 ));

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>testuser</username>
    <password>***</password>
  </credentials>
  <modifyCustomerRequest>
    <handle>JD911740-ES</handle>
    <address>
      <street>Castellano</street>
      <number>7</number>
      <suffix>3 D</suffix>
      <zipcode>10600</zipcode>
      <city>Madrid</city>
      <country>ES</country>
    </address>
    <phone>
      <countryCode>+34</countryCode>
      <areaCode>123</areaCode>
      <subscriberNumber>12345678</subscriberNumber>
    </phone>
    <email>myemail@gmail.com</email>
  </modifyCustomerRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
  </reply>
</openXML>
Views
Personal tools