domedit($domain, $edit, $auth) : Domain editing

Domain editing is a little more complicated. The procedure takes the domain name, the list of changes stored in a hash, and a set of credentials also in a hash. The credentials hash does two things:

• It describes the person editing the domain: either in relative terms to the domain e.g. org or admin, or in absolute terms i.e. the contact identifier.
• It provides proof that the editor really is who he claims. At the moment this is simply the contact's password.

For example, if the editor is the domain's registrant and his password is `elephant', then the credential hash should be

{ role => 'org', password => 'elephant' }
  

Sometimes the editor will be associated with more than one role, perhaps the domain's technical and billing contacts. In such circumstances, simply join the roles with colons e.g. `tech:bill'.

Alternatively an absolute description can be supplied e.g.

{ contact_id => 'edito763e', password => 'gibbon' }
  

Resource records

Unlike many other registries AdamsNames allows a more general set of resource records to be registered for each domain. In simple cases this will obviate the need to set up extra nameservers for the domain. The standard interface then, simply accepts a list of resource records and puts them in the relevant ccTLD zone file.

Obviously this doesn't preclude delegating the domain in the traditional fashion. Please note however, that it is an error to mix the two models: a domain is either delegated or not delegated.

It is important to realize that the edit here applies to the set of all resource records i.e. all the old records are deleted and replaced by the new set. There is no mechanism for updating a single record.

The price for this flexibility is extra complexity for client code in the common case of straightforward delegation to nameservers. Strictly the complexity only occurs when the nameservers lie within the zone itself, because then care must be taken to provide the correct `glue records'. For people in this position, we provide an alternative API: rather than supplying a list of resource records, simply supply a list of nameservers and we'll handle it.

Typically people delegating domains can simply pass a simple ns array e.g.

       [
         { name => 'ns1.foo.com', ipaddr => '123.45.67.89' },
         { name => 'ns2.foo.com', ipaddr => '123.45.89.67' },
       ]
  

Examples

In the examples below the xmlrpcdemo417487.tc domain has these contacts:

Registrant	adams364d
Admin. contact	adams516c
Billing contact	adams555f
Technical contact	adams530y

The registrant changes the nameservers

Request

  
domedit('xmlrpcdemo417487.tc', 
         { 'ns' => [ 
                        { 'ipaddr' => '123.45.67.89', 'name' => 'ns1.acme.com' }, 
                        { 'ipaddr' => '123.45.67.98', 'name' => 'ns2.acme.com' } 
                      ] }, 
         { 'contact_id' => 'adams364d', 'password' => 'abcdef650643' })

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>domedit</methodName>
  <params>
    <param>
      <value><string>xmlrpcdemo417487.tc</string></value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>ns</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>ipaddr</name>
                        <value><string>123.45.67.89</string></value>
                      </member>
                      <member>
                        <name>name</name>
                        <value><string>ns1.acme.com</string></value>
                      </member>
                    </struct>
                  </value>
                  <value>
                    <struct>
                      <member>
                        <name>ipaddr</name>
                        <value><string>123.45.67.98</string></value>
                      </member>
                      <member>
                        <name>name</name>
                        <value><string>ns2.acme.com</string></value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>contact_id</name>
            <value><string>adams364d</string></value>
          </member>
          <member>
            <name>password</name>
            <value><string>abcdef650643</string></value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

Return

{
  'error' => []
}

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>error</name>
            <value>
              <array><data/></array>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

The billing contact tries to change the DNS

Request

domedit('xmlrpcdemo417487.tc', 
        { 'rr' => [ { 'rclass' => 'txt', 'rdata' => 'This is bogus' } ] }, 
        { 'contact_id' => 'adams555f', 'password' => 'abcdef047025' })

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>domedit</methodName>
  <params>
    <param>
      <value><string>xmlrpcdemo417487.tc</string></value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>rr</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>rclass</name>
                        <value><string>txt</string></value>
                      </member>
                      <member>
                        <name>rdata</name>
                        <value><string>This is bogus</string></value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>contact_id</name>
            <value><string>adams555f</string></value>
          </member>
          <member>
            <name>password</name>
            <value><string>abcdef047025</string></value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

Return

{
  'error' => [
    [
      300,
      'Insufficient credentials to change RRs'
    ]
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>error</name>
            <value>
              <array>
                <data>
                  <value>
                    <array>
                      <data>
                        <value>
                          <int>300</int>
                        </value>
                        <value>
                          <string>Insufficient credentials...</string>
                        </value>
                      </data>
                    </array>
                  </value>
                </data>
              </array>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>