API Module Reseller searchContactRequest

From Openprovider API documentation

Revision as of 09:03, 26 January 2011 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Reseller > Search Contact== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Command n…') ← Older edit		Revision as of 09:04, 26 January 2011 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 23:		Line 23:
	|'''Output'''		|'''Output'''
	|Result set of contact details:		|Result set of contact details:
		+	*id
	*companyName		*companyName
	*[[API Format Name|name]]		*[[API Format Name|name]]

---

Revision as of 09:04, 26 January 2011

Contents 1 Module Reseller > Search Contact 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Reseller > Search Contact

Module	reseller
Command name	searchContactResellerRequest
Use	Searches for contacts in your reseller account
Input	limit default value: 100 offset default value: 0 emailPattern lastNamePattern companyNamePattern usernamePattern role (can be admin, tech or billing)
Output	Result set of contact details: id companyName name address phone email role isActive username

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchContactRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'offset' => 0,
   'limit'  => 25,
   'role' => 'tech',
));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchContactRequest>
    <offset>0</offset>
    <limit>25</limit>
    <role>tech</role>
  </searchContactRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    0
    <desc />
    <data>
      <results>
        <array>
          <item>
            <id>5391</id>
            <companyName></companyName>
            <name>
              <initials>J.B.</initials>
              <firstName>John</firstName>
              <prefix>van</prefix>
              <lastName>Halen</lastName>
            </name>
            <gender>M</gender>
            <phone>
              <countryCode>+31</countryCode>
              <areaCode>10</areaCode>
              <subscriberNumber>4482299</subscriberNumber>
            </phone>
            <address>
              <street></street>
              <number></number>
              <zipcode></zipcode>
              <city></city>
              <country></country>
            </address>
            <email>support@openprovider.nl</email>
            <role>tech</role>
            <isActive>1</isActive>
            <username>newUser</username>
          </item>
          <item>
            <id>3787</id>
            <companyName></companyName>
            <name>
              <initials></initials>
              <firstName>Andrew</firstName>
              <prefix></prefix>
              <lastName>Smith</lastName>
            </name>
            <gender>M</gender>
            <phone>
              <countryCode>+31</countryCode>
              <areaCode>010</areaCode>
              <subscriberNumber>4482299</subscriberNumber>
            </phone>
            <address>
              <street></street>
              <number></number>
              <zipcode></zipcode>
              <city></city>
              <country></country>
            </address>
            <email>navin@hosting-concepts.nl</email>
            <role>tech</role>
            <isActive>1</isActive>
            <username>andrew</username>
          </item>
          <item>
            <id>4556</id>
            <companyName></companyName>
            <name>
              <initials></initials>
              <firstName>Will</firstName>
              <prefix></prefix>
              <lastName>Black</lastName>
            </name>
            <gender>M</gender>
            <phone>
              <countryCode>+1</countryCode>
              <areaCode>952</areaCode>
              <subscriberNumber>9350016</subscriberNumber>
            </phone>
            <address>
              <street></street>
              <number></number>
              <zipcode></zipcode>
              <city></city>
              <country></country>
            </address>
            <email>support@openprovider.nl</email>
            <role>tech</role>
            <isActive>1</isActive>
            <username>willb</username>
          </item>
        </array>
      </results>
      <total>3</total>
    </data>
  </reply>
</openXML>