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 createCustomerRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 35: Line 35:
  $request = new OP_Request;
  $request = new OP_Request;
  $request->setCommand('createCustomerRequest')
  $request->setCommand('createCustomerRequest')
-
  ->setAuth(array('username' => 'username', 'password' => 'password'))
+
->setAuth(array('username' => $username, 'password' => $password))
-
  ->setArgs(array(
+
->setArgs(array(
-
    'name' => array(
+
  'name' => array(
-
      'initials' => 'J.B.',
+
    'initials' => 'J.B.',
-
      'firstName' => 'John',
+
    'firstName' => 'John',
-
      'prefix' => 'van',
+
    'prefix' => 'van',
-
      'lastName' => 'Halen',
+
    'lastName' => 'Halen',
-
    ),
+
  ),
-
+
 
-
    'gender' => 'M',  
+
  'gender' => 'M',  
-
+
 
-
    'phone' => array(
+
  'phone' => array(
-
      'countryCode' => '+31',
+
    'countryCode' => '+31',
-
      'areaCode' => '10',
+
    'areaCode' => '10',
-
      'subscriberNumber' => '4482299'
+
    'subscriberNumber' => '4482299'
-
    ),
+
  ),
-
+
 
-
    'fax' => array(
+
  'fax' => array(
-
      'countryCode' => '+31',
+
    'countryCode' => '+31',
-
      'areaCode' => '10',
+
    'areaCode' => '10',
-
      'subscriberNumber' => '2440250'
+
    'subscriberNumber' => '2440250'
-
    ),
+
  ),
-
+
 
-
    'address' => array(
+
  'address' => array(
-
      'street' => 'Nieuwe Binnenweg',
+
      'street' => 'Nieuwe Binnenweg',
-
      'number' => '137',
+
      'number' => '137',
-
      'suffix' => 'a',
+
      'suffix' => 'a',
-
      'zipcode' => '3014 GJ',
+
      'zipcode' => '3014 GJ',
-
      'city' => 'Rotterdam',
+
      'city' => 'Rotterdam',
-
      'state' => 'Zuid-Holland',
+
      'state' => 'Zuid-Holland',
-
      'country' => 'NL',
+
      'country' => 'NL',
-
    ),
+
  ),
-
+
 
-
    'email' => 'support@openprovider.nl',
+
  'email' => 'support@openprovider.nl',
-
+
  'locale' => 'el_GR',
-
    'additionalData' => array(
+
 
-
      'birthCity' => 'Amsterdam',
+
  'additionalData' => array(
-
      'birthDate' => '1971-02-14',
+
    'birthCity' => 'Amsterdam',
-
      'socialSecurityNumber' => '771268635',
+
    'birthDate' => '1971-02-14',
-
      'companyRegistrationNumber' => '115372'
+
    'socialSecurityNumber' => '771268635',
-
    ),
+
    'companyRegistrationNumber' => '115372'
-
    'extensionAdditionalData' => array(
+
  ),
-
      array(
+
  'extensionAdditionalData' => array(
-
      'name' => 'pro',
+
    array(
-
      'data' => array(
+
      'name' => 'us',
-
        'profession' => 'software developer',
+
      'data' => array(
-
        'authorityName' => 'openprovider',
+
         'nexusCategory' => 'C31',
-
        'licenseNumber' => '12345678',
+
         'applicantPurpose' => 'P1'
-
        'authorityUrl' => 'http://openprovider.com'
+
-
         )
+
-
      ),
+
-
      array(
+
-
      'name' => 'jobs',
+
-
      'data' => array(
+
-
         'website' => 'http://openprovider.com'
+
-
      )
+
       )
       )
     ),
     ),
-
  ));
+
    ),
 +
));
===Raw XML===
===Raw XML===
Line 133: Line 126:
     </address>
     </address>
     <email>info@openprovider.nl</email>
     <email>info@openprovider.nl</email>
 +
    <locale>el_GR</locale>
     <additionalData>
     <additionalData>
       <birthCity>London</birthCity>
       <birthCity>London</birthCity>
Line 141: Line 135:
     <array>
     <array>
       <item>
       <item>
-
       <name>pro</name>
+
       <name>us</name>
         <data>
         <data>
-
         <profession>software developer</profession>
+
         <nexusCategory>C31</nexusCategory>
-
         <authorityName>openprovider</authorityName>
+
         <applicantPurpose>P1</applicantPurpose>
-
        <licenseNumber>12345678</licenseNumber>
+
-
        <authorityUrl>http://openprovider.com</authorityUrl>
+
         </data>
         </data>
       </item>
       </item>
-
       <item>
+
       </array>
-
      <name>jobs</name>
+
-
      <data>
+
-
        <website>http://openprovider.com</website>
+
-
      </data>
+
-
      </item>
+
-
    </array>
+
     </extensionAdditionalData>
     </extensionAdditionalData>
   </createCustomerRequest>
   </createCustomerRequest>

Revision as of 10:13, 24 October 2017

Contents

Module Customer > Create

Module customer
Command name createCustomerRequest
Use Creates an entry for a new customer
Input
Output

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createCustomerRequest')
->setAuth(array('username' => $username, 'password' => $password))
->setArgs(array(
  'name' => array(
    'initials' => 'J.B.',
    'firstName' => 'John',
    'prefix' => 'van',
    'lastName' => 'Halen',
  ),
  'gender' => 'M', 
  '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',
  'locale' => 'el_GR',
  'additionalData' => array(
    'birthCity' => 'Amsterdam',
    'birthDate' => '1971-02-14',
    'socialSecurityNumber' => '771268635',
    'companyRegistrationNumber' => '115372'
  ),
  'extensionAdditionalData' => array(
   array(
     'name' => 'us',
     'data' => array(
       'nexusCategory' => 'C31',
       'applicantPurpose' => 'P1'
     )
   ),
   ),
));

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>
  <createCustomerRequest>
    <companyName>Hosting Unlimited</companyName>
    <vat></vat>
    <name>
      <initials>J.B.</initials>
      <firstName>John</firstName>
      <prefix>van</prefix>
      <lastName>Halen</lastName>
    </name>
    <gender>M</gender>
    <phone>
      <countryCode>+8</countryCode>
      <areaCode>383</areaCode>
      <subscriberNumber>1231212</subscriberNumber>
    </phone>
    <fax>
      <countryCode>+8</countryCode>
      <areaCode>383</areaCode>
      <subscriberNumber>1231213</subscriberNumber>
    </fax>
    <address>
      <street>Main Street</street>
      <number>2</number>
      <suffix>a</suffix>
      <zipcode>630060</zipcode>
      <city>Washington</city>
      <state></state>
      <country>US</country>
    </address>
    <email>info@openprovider.nl</email>
    <locale>el_GR</locale>
    <additionalData>
      <birthCity>London</birthCity>
      <birthCountry>GB</birthCountry>
      <birthDate>1976-03-24</birthDate>
    </additionalData>
   <extensionAdditionalData>
    <array>
     <item>
      <name>us</name>
       <data>
        <nexusCategory>C31</nexusCategory>
        <applicantPurpose>P1</applicantPurpose>
       </data>
     </item>
     </array>
   </extensionAdditionalData>
  </createCustomerRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <handle>JH000001-US</handle>
    </data>
  </reply>
</openXML>
Views
Personal tools