QueryRegisteredPremiumDomainList
The QueryRegisteredPremiumDomainList command allows you to query the list of premium domains in your portfolio or located in subreseller accounts.
Possible Gateways
The command QueryRegisteredPremiumDomainList is available via the following gateways:
Required Parameters
The following parameters are standard parameters for this command.
Command
COMMAND = QueryRegisteredPremiumDomainList
Response
code = (INT)
description = (TEXT)
property[DOMAIN][n] = (DOMAIN)
property[REGISTRAR][n] = (TEXT)
property[COUNT][0] = (INT)
property[FIRST][0] = (INT)
property[LAST][0] = (INT)
property[LIMIT][0] = (INT)
property[TOTAL][0] = (INT)
Attributes
DOMAIN | A domain matching the search - filter |
DOMAIN_IDN | The UTF-8 - version of the domain |
ROID | Registry Object ID for this domain |
DOMAIN_CREATED_DATE | The date, when the domain was created |
DOMAIN_CREATED_BY | Account, in which the domain was created |
DOMAIN_UPDATED_DATE | The date, when the domain was last updated |
DOMAIN_UPDATED_BY | Account, who did the last modification on this domain |
DOMAIN_REGISTRATION_EXPIRATION_DATE | When will the domain expire |
DOMAIN_RENEWAL_DATE | When must the domain be renewed |
DOMAIN_ZONE | Zone of the domain name |
RENEWALMODE | The current renewalmode of the domain |
TRANSFERMODE | The current transfer mode of the domain |
COUNT | Total number of domains shown |
FIRST | Pointer to the first shown ID |
LAST | Pointer to the last shown ID |
LIMIT | The limit given in the command |
TOTAL | Total number of domains matching the criteria |
Optional
The following parameters are optional for this command.
Command
COMMAND = QueryRegisteredPremiumDomainList
DOMAIN = (PATTERN)
DOMAINIDN = (TEXT)
RENEWALMODE = DEFAULT|AUTORENEW|AUTOEXPIRE|AUTODELETE|RENEWONCE|AUTORENEWMONTHLY
ZONE = (PATTERN)
REGISTRAR = (PATTERN)
INCLUDESUB = 0|1
ONLYSUB = 0|1
ORDER = ASC|DESC
ORDERBY = DOMAIN|DOMAINIDN|DOMAINCREATEDDATE|DOMAINREGISTRATIONEXPIRATIONDATE|DOMAINRENEWALDATE|DOMAINZONE|ZONE|RENEWALMODE|TRANSFERMODE
WIDE = 0|1
FIRST = (INT)
LIMIT = (INT)
Response
code = (INT)
description = (TEXT)
property[DOMAIN][n] = (DOMAIN)
property[REGISTRAR][n] = (TEXT)
property[DOMAIN_IDN][n] = (TEXT)
property[ROID][n] = (TEXT)
property[DOMAIN_CREATED_DATE][n] = (DATE)
property[DOMAIN_CREATED_BY][n] = (TEXT)
property[DOMAIN_UPDATED_DATE][n] = (DATE)
property[DOMAIN_UPDATED_BY][n] = (TEXT)
property[DOMAIN_REGISTRATION_EXPIRATION_DATE][n] = (DATE)
property[DOMAIN_RENEWAL_DATE][n] = (DATE)
property[DOMAIN_ZONE][n] = (TEXT)
property[RENEWALMODE][n] = (TEXT)
property[TRANSFERMODE][n] = (TEXT)
property[COUNT][0] = (INT)
property[FIRST][0] = (INT)
property[FIRST][0] = (INT)
property[LAST][0] = (INT)
property[LIMIT][0] = (INT)
property[TOTAL][0] = (INT)
Attributes
INCLUDESUB | Also lists premium domains of subreseller accounts if set to 1 (optional, DEFAULT 0) |
ONLYSUB | Only lists premium domains of subreseller accounts if set to 1. Also sets INCLUDESUB to 1 if used. (optional, DEFAULT 0) |
DOMAIN | Filter the result by this string (wildcards allowed, optional) |
DOMAINIDN | Filter the result by this string (wildcards allowed, optional) |
ORDER | Ascending or descending result order (optional) |
ORDERBY | Sort the result by this column (optional) |
RENEWALMODE | The Renewalmode selected for this domain (optional) |
ZONE | Show only domains matching this zone (optional) |
REGISTRAR | Show only domains of this registrar. (optional) |
WIDE | Show more or less details in the results (optional) |
FIRST | Start the output of results from this item (optional) |
LIMIT | Show only this many items in the response (optional) |