API Module Nsgroup searchNsGroupRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Nameserver group > Search) |
|||
| (7 intermediate revisions not shown) | |||
| Line 13: | Line 13: | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
| - | *limit ''default value: 100'' | + | *[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'') |
| - | *offset ''default value: 0'' | + | *[[API Format Offset|offset]] (''default value: 0'') |
| - | *nsGroupPattern | + | *nsGroupPattern (to search for all nameserver groups with matching name pattern) |
| - | *nsNamePattern | + | *nsNamePattern (to search for all nameserver groups with nameservers matching hostname pattern) |
| - | *nsIpPattern | + | *nsIpPattern (to search for all nameserver groups with nameservers matching IP address pattern) |
| - | *withDomainCount ''default value: 0'' | + | *withDomainCount (''default value: 0'') |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
|Result set of extension details: | |Result set of extension details: | ||
| - | *nsGroup | + | *[[API Format nsGroup|nsGroup]] |
| - | *[[API Format | + | *[[API Format Nameservers|nameServers]] |
*domainCount (if withDomainCount = true) | *domainCount (if withDomainCount = true) | ||
|} | |} | ||
| Line 36: | Line 36: | ||
===Raw XML=== | ===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"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<openXML> | <openXML> | ||
| Line 48: | Line 49: | ||
<openXML> | <openXML> | ||
<reply> | <reply> | ||
| - | < code>0</code> | + | <nowiki><code>0</code></nowiki> |
<desc></desc> | <desc></desc> | ||
<data> | <data> | ||
Current revision as of 10:51, 17 June 2016
Contents |
Module Nameserver group > Search
| Module | Nameserver group |
| Command name | searchNsGroupRequest |
| Use | Returns a list of nameserver group objects matching search criteria |
| Input |
|
| Output | Result set of extension details:
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('searchNsGroupRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
));
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>
<searchNsGroupRequest />
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
<desc></desc>
<data>
<results>
<array>
<item>
<nameServers>
<array>
<item>
<name>ns1.openprovider.nl</name>
<ip>89.255.7.30</ip>
</item>
<item>
<name>ns2.openprovider.be</name>
<ip>89.255.6.30</ip>
</item>
<item>
<name>ns3.openprovider.eu</name>
<ip>80.95.170.252</ip>
</item>
</array>
</nameServers>
<nsGroup>server-tux</nsGroup>
<nsCount>3</nsCount>
</item>
</array>
</results>
<total>1</total>
</data>
</reply>
</openXML>