SearchDomains()

From Rackspace Email & Apps API
Revision as of 15:02, 25 August 2008 by APIAdmin (talk | contribs) (New page: This function will search the list of domains associated with the provided admin user for all instances where the domain name matches the partial string supplied as the search argument. N...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This function will search the list of domains associated with the provided admin user for all instances where the domain name matches the partial string supplied as the search argument. No wildcards available. The domain name, account #, and account name for all matching accounts are returned. Please note that if a reseller username is supplied, the search will include the domains associated with all sub-accounts.

Parameters

Four strings:

   Administrative username,
   Administrative password,
   Search string, (case insensitive)
   Domain listing ("domain name, account #, account name [crlf] domain name, account #, account name [crlf] …”)

Return Values

If successful, the return value of the function will be 1.

The domain listing will hold a list of domains, account numbers, and account names associated with the reseller username and password supplied which match the search string.

Consult the Result Code Table for a list of result codes and their meaning.