QueryDomainList
Query list of domains in account
Possible Gateways
The command QueryDomainList is available via the following gateways:
Required Parameters
The following parameters are standard parameters for this command.
Command
COMMAND = QueryDomainListResponse
code = (INT)
description = (TEXT)
property[DOMAIN][n] = (DOMAIN)
property[DOMAIN_IDN][n] = (TEXT)
property[ROID][n] = (TEXT)
property[DOMAIN_CREATED_DATE][n] = (DATE)
property[DOMAIN_ZONE][n] = (TEXT)
property[DOMAIN_CREATED_BY][n] = (TEXT)
property[TYPE][n] = RENEW|TRANSFER
property[AMOUNT][n] = (DECIMAL)
property[DOMAIN_UPDATED_DATE][n] = (DATE)
property[DOMAIN_UPDATED_BY][n] = (TEXT)
property[VAT][n] = (DECIMAL)
property[CURRENCY][n] = (TEXT)
property[DOMAIN_REGISTRATION_EXPIRATION_DATE][n] = (DATE)
property[DOMAIN_RENEWAL_DATE][n] = (DATE)
property[RENEWALMODE][n] = (TEXT)
property[CONTACT][n] = (TEXT)
property[VERIFIED][n] = (TEXT)
property[X-TIME-TO-SUSPENSION][n] = (TEXT)
property[TRANSFERMODE][n] = (TEXT)
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; Will only be returned if TYPE is DEFAULT | SHOWRENEW |
| ROID | Registry Object ID for this domain; Will only be returned if TYPE is DEFAULT | SHOWRENEW | SHOWGRACE |
| DOMAIN_CREATED_DATE | The date, when the domain was created; Will only be returned if TYPE is DEFAULT | SHOWRENEW | SHOWGRACE |
| DOMAIN_ZONE | Zone of the domain name |
| DOMAIN_CREATED_BY | Account, in which the domain was created; Will only be returned if TYPE is DEFAULT | SHOWRENEW | SHOWGRACE |
| TYPE | Why was the domain renewed; Will only be returned if TYPE is SHOWRENEWED |
| AMOUNT | Amount charged for the renewal; Will only be returned if TYPE is SHOWRENEWED |
| DOMAIN_UPDATED_DATE | The date, when the domain was last updated; Will only be returned if TYPE is DEFAULT |
| DOMAIN_UPDATED_BY | Account, who did the last modification on this domain; Will only be returned if TYPE is DEFAULT |
| VAT | V.A.T. charged for the renewal; Will only be returned if TYPE is SHOWRENEWED |
| CURRENCY | The currency used to charge the renewal; Will only be returned if TYPE is SHOWRENEWED |
| DOMAIN_REGISTRATION_EXPIRATION_DATE | When will the domain expire; Will only be returned if TYPE is DEFAULT | SHOWRENEW | SHOWGRACE |
| DOMAIN_RENEWAL_DATE | When must the domain be renewed |
| RENEWALMODE | The current renewalmode of the domain; Will only be returned if TYPE is DEFAULT | SHOWRENEW |
| CONTACT | Owner contact of the domain; Will only be returned if TYPE is ALL / SHOWUNVERIFIED |
| VERIFIED | Verified owner contact; Will only be returned if TYPE is DEFAULT |
| X-TIME-TO-SUSPENSION | The date when the domain will be suspended if the email verification is not done; Will only be returned if TYPE is DEFAULT |
| TRANSFERMODE | The current transfer mode of the domain; Will only be returned if TYPE is DEFAULT |
| REGISTRAR | Registrar account of the domain; Will only be returned if TYPE is SHOWSUBLAYER | SHOWMERGEDLAYER |
| 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 = QueryDomainList
DOMAIN = (PATTERN)
DOMAINIDN = (TEXT)
DAYS = (INT)
ORDER = ASC|DESC
ORDERBY = DOMAIN|DOMAINIDN|DOMAINCREATEDDATE|DOMAINREGISTRATIONEXPIRATIONDATE|DOMAINRENEWALDATE|DOMAINZONE|ZONE|RENEWALMODE|TRANSFERMODE|DOMAINUPDATEDDATE|X-TRANSFERLOCK-UNTIL
RENEWALMODE = DEFAULT|AUTORENEW|AUTOEXPIRE|AUTODELETE|RENEWONCE|AUTORENEWMONTHLY|EXPIREAUCTION
TYPE = DEFAULT|SHOWGRACE|SHOWRENEW|SHOWRENEWED|SHOWSUBLAYER|SHOWMERGEDLAYER|SHOWSUSPENDED|SHOWUNVERIFIED|SHOWUNVALIDATED|SHOWERRP|SHOWTRANSFERLOCK|ALL
ZONE = (PATTERN)
REGISTRAR = (PATTERN)
WIDE = 0|1
GENERATELIST = 0|1
SENDLISTEMAIL = (EMAILS)
FIRST = (INT)
LIMIT = (INT)
DOMAINTAG# = (TEXT)
ZONETAG# = (TEXT)
NAMESERVER = (PATTERN)Response
code = (INT)
description = (TEXT)
property[DOMAIN][n] = (DOMAIN)
property[DOMAIN_IDN][n] = (TEXT)
property[ROID][n] = (TEXT)
property[DOMAIN_CREATED_DATE][n] = (DATE)
property[DOMAIN_ZONE][n] = (TEXT)
property[DOMAIN_CREATED_BY][n] = (TEXT)
property[TYPE][n] = RENEW|TRANSFER
property[AMOUNT][n] = (DECIMAL)
property[DOMAIN_UPDATED_DATE][n] = (DATE)
property[DOMAIN_UPDATED_BY][n] = (TEXT)
property[VAT][n] = (DECIMAL)
property[CURRENCY][n] = (TEXT)
property[DOMAIN_REGISTRATION_EXPIRATION_DATE][n] = (DATE)
property[DOMAIN_RENEWAL_DATE][n] = (DATE)
property[RENEWALMODE][n] = (TEXT)
property[CONTACT][n] = (TEXT)
property[VERIFIED][n] = (TEXT)
property[X-TIME-TO-SUSPENSION][n] = (TEXT)
property[X-TRANSFERLOCK-UNTIL][n] = (DATE)
property[TRANSFERMODE][n] = (TEXT)
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 | Filter the result by this string (wildcards allowed, optional) |
| DOMAINIDN | Filter the result by this string (wildcards allowed, optional) |
| DAYS | Set the number of days required for TYPE is SHOWRENEW|SHOWRENEWED (optional) |
| ORDER | ASC|DESC (optional) |
| ORDERBY | Sort the result by this column (optional) |
| RENEWALMODE | The Renewalmode selected for this domain (optional) |
| TYPE | Select the dataset based on different criterias (optional) |
| DEFAULT | The normal domainlist |
| SHOWGRACE | All domains currently in the Add Grace - period |
| SHOWRENEW | All domains, which will be renewed during the next X days |
| SHOWRENEWED | All domains, which were renewed during the last X days |
| SHOWSUBLAYER | Show all domains located on suberseller accounts |
| SHOWMERGEDLAYER | Show all domains including own and all subreseller domains |
| SHOWSUSPENDED | Show all suspended domains |
| SHOWUNVERIFIED | Show all domains with unverified owner contacts |
| SHOWUNVALIDATED | Show all domains with unvalidated owner contacts |
| SHOWERRP | Show all domains within ERRP |
| ALL | The regular domain list including comma separated data of authcode, name servers, status and contacts |
| 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) |
| GENERATELIST | Show result on screen|Generate a CSV File and upload to ftp (optional) |
| SENDLISTEMAIL | Email address where the CSV will be sent to (optional) |
| FIRST | Start the output of results from this item (optional) |
| LIMIT | Show only this many items in the response (optional) |
| DOMAINTAG# | Show only domains that are associated with this domain tag. (optional) |
| ZONETAG# | Show only domains that are associated with this zone tag. (optional) |
| NAMESERVER | Filter the result by this string (wildcards allowed, optional). Only available for TYPE is ALL. |
| X-TRANSFERLOCK-UNTIL | Date until the transferlock of the domain name will expire |