.. _epp-domain-info:

Domain Info
===========

Requests detailed information about a registered domain name.
This command mostly follows standard EPP Domain name mapping, `RFC-5731`_,
with a simple optional extension for responses.

Client request
--------------

The only parameter is ``domain:name`` which should be given in it's :term:`ACE encoded form <ACE-encoded domain name>`.
``domain:name`` may have a ``hosts`` attribute with following values:

* ``all`` include in response all nameservers associated with the domain name (this happens by default)
* ``sub`` show only subordinate networks (being subdomains of the requested domain name)
* ``del`` only delegated networks (having no IP address) should be shown
* ``none`` do not include network information in response

(see `RFC-5731 explanation <http://tools.ietf.org/html/rfc5731#section-1.1>`_ what subordinate and delegated hosts means in EPP terminology).

.. note ::

   Please, use <domain:check> command to get a hint of whether the domain name is available for new registrations.
   <domain:info> as a more "heavy" request is not a good choice for doing that.

Example of the request:

.. code-block :: xml

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
      <command>
        <info>
          <domain:info
           xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
           xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">
           <domain:name hosts='all'>example-mydomain.lv</domain:name>
          </domain:info>
        </info>
        <clTRID>mFvZwyJKYHYmWpgS2JlG</clTRID>
      </command>
    </epp>

Server response
---------------

When an ``<domain:info>`` command has been processed successfully, the ``domain:infData`` element will contain
all the information associated with the domain (if the domain name is managed by the caller).

Following elements are always present:

* ``domain:name`` domain name in its ACE-encoded form
* ``domain:roid`` a unique repository  object identifier, derived from the name of the domain
* ``domain:clID`` client ID (login name) of the registrar, "sponsoring" the domain
* ``domain:registrant`` contact handle of the holder of the domain name
* ``domain:contact`` a list of contact handles of billing, administrative and technical contact persons, linked to the domain

  + type="admin" client handle of administrative contact person
  + type="billing" contains client handle of the :term:`registrar's primary person`
  + type="tech" client handle of the registrar's hostmaster contact, responsible for the domain

* One or more ``domain:status`` elements, whose "s" attribute names the state the domain is in
  (please, see the list of possible :ref:`states <epp-domain-states-list>` that domains could have)

* ``domain:ns`` with a list of ``domain:hostAttr`` tags, each describing one nameserver for that domain:

   + ``domain:hostName`` containing host name of the nameserver
   + ``domain:hostAddr`` contains it's IP address *(only for subordinated nameservers which are subdomains of the domain name)*

* ``domain:crID`` EPP client ID of the registrar which originally registered that domain
  (may be absent or contain some special string, prefixed with two underscores for domain names registered before their registrar had an EPP account)
* ``domain:exDate`` contains the date when the domain is going to expire

  .. note ::

     If a domain name is for free (like .id.lv domain names for Latvian private persons,
     domain names for schools and local governments - please, see `Policy for the acquisition of the right to use domain names under the top-level domain .lv`_, section 8, for more details),
     it never expires, so, absence of ``domain:exDate`` element allows to recognize domain names which are for free from those the registrar should pay for.

* ``domain:crDate`` date (in UTC) when the registration request form was submitted
* ``domain:upID`` EPP client ID of the registrar who last updated the domain details (which could only be the caller).
  May contain string ``__SERVER__`` or ``__NIC-STAFF__`` if the changes were made as a side effect of some offline process, in nic.lv online system or by our staff.
* ``domain:upDate`` date (in UTC) of last change of domain name or it's networks
* ``domain:trDate`` date (in UTC) when the last registrar change request was successfully performed

Response for the client, managing the queried domain name:

.. code-block :: xml

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
      <response>
        <resData>
          <domain:infData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">
            <domain:name>example-mydomain.lv</domain:name>
            <domain:roid>DOM-example-mydomain-test-client</domain:roid>
            <domain:status s="ok"/>
            <domain:registrant>regi0412-12345</domain:registrant>
            <domain:contact type="admin">huma1208-192</domain:contact>
            <domain:contact type="tech">client-adm0</domain:contact>
            <domain:contact type="billing">client-bill</domain:contact>
            <domain:ns>
              <domain:hostAttr>
                <domain:hostName>ns.example-mydomain.lv</domain:hostName>
                <domain:hostAddr ip="v4">92.240.65.139</domain:hostAddr>
              </domain:hostAttr>
              <domain:hostAttr>
                <domain:hostName>ns.nonexisting.lv</domain:hostName>
              </domain:hostAttr>
            </domain:ns>
            <domain:clID>test-client</domain:clID>
            <domain:crDate>2011-04-09T13:04:03+03:00</domain:crDate>
            <domain:exDate>2012-04-09T13:04:03+03:00</domain:exDate>
            <domain:upID>test-client</domain:upID>
            <domain:upDate>2011-06-09T13:04:03+03:00</domain:upDate>
          </domain:infData>
        </resData>
        <result code="1000">
          <msg>Command completed successfully</msg>
        </result>
        <trID>
          <clTRID>mFvZwyJKYHYmWpgS2JlG</clTRID>
          <svTRID>test-client-20110610-7588be280bc126bb22c1f7cd4d46b975-8</svTRID>
        </trID>
      </response>
    </epp>

Also, an ``<extension>`` element may be present with a ``lvdomain:infData`` tag, which currently may contain:

* ``<lvdomain:status s="clientAutoRenewProhibited"/>`` meaning that domain should be paid for during this month
  but the registrar has decided not to auto-renew it after payment for the current bill is made.

Response for the sponsoring client if the domain is included in the actual bill
and the client has chosen to not renew it:

.. code-block :: xml

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
      <response>
        <result code="1000">
          <msg lang="en">Command completed successfully</msg>
        </result>
        <resData>
          <domain:infData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">
            <domain:name>example-mydomain.lv</domain:name>
            <domain:roid>DOM-example-mydomain-test-client</domain:roid>
            <domain:status s="ok"/>
            <domain:registrant>regi0412-12345</domain:registrant>
            <domain:contact type="admin">huma1208-192</domain:contact>
            <domain:contact type="tech">client-adm0</domain:contact>
            <domain:contact type="billing">client-bill</domain:contact>
            <domain:ns>
              <domain:hostAttr>
                <domain:hostName>ns.example-mydomain.lv</domain:hostName>
                <domain:hostAddr ip="v4">92.240.65.139</domain:hostAddr>
              </domain:hostAttr>
              <domain:hostAttr>
                <domain:hostName>ns.nonexisting.lv</domain:hostName>
              </domain:hostAttr>
            </domain:ns>
            <domain:clID>test-client</domain:clID>
            <domain:crDate>2011-04-09T13:04:03+03:00</domain:crDate>
            <domain:exDate>2012-04-09T13:04:03+03:00</domain:exDate>
            <domain:upID>test-client</domain:upID>
            <domain:upDate>2011-06-09T13:04:03+03:00</domain:upDate>
          </domain:infData>
        </resData>
        <extension>
          <lvDomain:infData xmlns:lvdomain="http://www.nic.lv/epp/schema/lvdomain-ext-1.0" xsi:schemaLocation="http://www.nic.lv/epp/schema/lvdomain-ext-1.0 lvdomain-ext-1.0.xsd">
            <lvDomain:status s="clientAutoRenewProhibited" lang="en">Client didnt want to keep domain</lvDomain:status>
          </lvDomain:infData>
        </extension>
        <trID>
          <clTRID>5dce9c360978e</clTRID>
          <svTRID>test-client-20191115-b8a145385b307781733faa5b996313bf-14</svTRID>
        </trID>
      </response>
    </epp>

Response if the domain name is managed by another registrar:

.. code-block :: xml

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
      <response>
        <resData>
          <domain:infData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">
            <domain:name>example-mydomain.lv</domain:name>
            <domain:roid>DOM-example-mydomain-test-client</domain:roid>
            <domain:clID>AlienLTD</domain:clID>
          </domain:infData>
        </resData>
        <result code="1000">
          <msg>Command completed successfully</msg>
        </result>
        <trID>
          <clTRID>ibZ3LBhHSUZRQAkRkseG</clTRID>
          <svTRID>test-client-20110609-0b982ee72f9f311ba46fd2c41fa29613-6</svTRID>
        </trID>
      </response>
    </epp>

.. include:: /ref_links.rst