API Module Customer createCustomerRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 07:24, 17 June 2016

Module Customer > Create

Module	customer
Command name	createCustomerRequest
Use	Creates an entry for a new customer
Input	companyName vat name gender address phone fax email additionalData extensionAdditionalData tags
Output	handle

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',

   '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>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>
    <additionalData>
      <birthCity>London</birthCity>
      <birthCountry>GB</birthCountry>
      <birthDate>1976-03-24</birthDate>
    </additionalData>
   <extensionAdditionalData>
    <array>
     <item>
      <name>pro</name>
       <data>
        <profession>software developer</profession>
        <authorityName>openprovider</authorityName>
        <licenseNumber>12345678</licenseNumber>
        <authorityUrl>http://openprovider.com</authorityUrl>
       </data>
     </item>
     <item>
      <name>jobs</name>
      <data>
       <website>http://openprovider.com</website>
      </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>

@@ Line 14: / Line 14: @@
 |
 *companyName
-*vat
+*[[API Format vat|vat]]
 *'''[[API Format Name|name]]'''
 *'''[[API Format Gender|gender]]'''