The List operation returns a list of all of the details for the domains names you specify.
Guidelines
Instructions
-
Send to the address auto-list@nic.uk
-
Use a subject line of TAG List (replace TAG with the name of your tag in capital letters)
-
Specify the month of registration using one of the templates below
-
The Automaton will return a list containing all matching domain name registrations and all of the register fields for those domains.
Operation template 1 - registration date
This list operation returns all those domains on your tag registered within a particular month of a particular year. This template is in the following format:
operation: list
month: YYYY-MM
where YYYY = year (e.g. 1996) and MM = month (e.g. 08).
This list operation returns all those domains on your tag due to expire within a particular month of a particular year. This template is in the following format:
operation: list
expiry: YYYY-MM
where YYYY = year (e.g. 2004) and MM = month (e.g. 08).
Operation template 3 - any date
This list operation returns all domains on your tag regardless of registration date. This template is in the following format:
operation: list
month: all
Reply template
The Automaton will send back a list in the following format:
Domain Name List follows...
Domain name|reg-status|registrar-tag|created|changed|expiry|first-bill|recur-bill|
auto-bill|next-bill|dns0|dns0-id|dns1|dns1-id|dns2|dns2-id||dns3|dns3-id|dns4|
dns4-id|dns5|dns5-id|dns6|dns6-id|dns7|dns7-id|dns8|dns8-id|dns9|dns9-id|
account-id|account-name
Number of domains in the list: [Number].
If you have any questions please contact support@nominet.org.uk.
Documentation on the automaton can be found on the Nominet Web site
at http://www.nominet.org.uk/go/automaton
Notes:
- There are no line breaks in the data fields in the actual reply. These are only shown here for illustrative purposes. In the actual message the data for each domain is on one line. There is one line of data for each domain.
- Both nameserver data and ids are included.
- All dates are in the format CCYYMMDD.
- [Number] is replaced with the correct number for the number of domains returned.
- All new line characters are replaced with '^'.
- The maximum outgoing message size the Automaton can send is limited to 250MB. This equates to a list message of approximately 500,000 domains.
- The definition for the fields can be found here. The registrar-tag field will be ips-key and account-name registrant if you have the backwards compatibility option switched on.
- If you need to return field names other than those listed here then either use the bulk automaton or see here for how to return all field names.
Errors
After processing your operation the Automaton produces and sends an automated reply. If there is a problem with the operation then two different error condition may occur
- non-fatal errors (warning messages) may be appended to successful replies.
- fatal errors that prevents the operation from being carried out and so an error reply is generated.
Full details of the template of the error reply and the meaning of the error messages can be found
here.