DOMAIN NAMES

4.1 Request Structure

The request structure looks as follows

<request version="1.0" id="REQUEST-123456"> + <reseller id="962903141509"> + <add-domain fqdn="domain1.com"> + <modify-domain fqdn="domain2.com"> + <delete-domain fqdn="domain3.com"> </request>

4.1.1 <?xml version='1.0' ?>

This is the header of an XML request or response.

4.1.2 <request version="1.0" id="REQUEST-123456">

This marks the beginning of the request structure. The end is marked by the last line </request>. The id is a Partner generated ID which can be used for internal tracking.

4.1.3 <reseller …>

The reseller node is used for authentication and has the following format

<reseller id="9876543210"> <password>secret</password> <plan-id>7</plan-id> </reseller>

The id attribute is Partner’s Registration number in Names4Ever. The password node is Partner’s password. The plan-id node is Partner’s plan ID in Names4Ever. All those three parameters you will receive when subscribe for Names4Ever partner program.

4.1.4 <add-domain>

The add-domain node is used for new domain name registration request and has the following format.

<add-domain fqdn="domain1.com"> <password>secret</password> <organization>Organization</organization> <ns priority="1" fqdn="ns1.domain1.com"> <ip>10.10.10.20</ip> </ns> <ns priority="2" fqdn="ns1.reseller.com" /> + <contact type="admin"> + <contact type="tech"> + <contact type="billing"> <registration-period>2</registration-period> </add-domain>

The fqdn attribute is required and contains domain name to be registered. The password node is domain’s password, which is required for future modification or deletion of the domain. The organization node is required and contains registrant’s organization.

The ns nodes are domain name servers for the domain. You should specify at least one ns node with priority 1. The maximum number of name servers is 4 and their priorities should be sequential. The ns node can contain an ip node with IP address of the specified DNS. If IP address is not supplied Names4Ever module will resolve the IP address of the DNS.

The contact nodes are contact information for the domain. They can be of type admin, tech or billing. You should submit at least admin contact in order to successfully register domain name.

The registration-period node contains the requested domain name registration period in years.

4.1.5 <modify-domain>

The modify-domain node is used for modifying name servers or contacts for previously registered domain name and has the following format:

<modify-domain fqdn="domain2.com"> <password>secret</password> <organization>Organization</organization> <ns priority="2" fqdn="ns2.domain2.com" /> + <contact type="admin"> + <contact type="tech"> + <contact type="billing"> </modify-domain>

The meaning of all subnodes is the same as in add-domain node.

4.1.6 <delete-domain>

The delete-domain node is used for deleting previously registered domain names and has the following format:

<delete-domain fqdn="domain3.com"> <password>secret</password> </delete-domain>

4.2 Response Structure

The response structure looks as follows

<response version="1.0" requestid="REQUEST-123456"> <status code="0"> <description>OK</description> <status> <domain name="domain1.com"> <code>0</code> <description>Successfully added</description> </domain> <domain name="domain2.com"> <code>12</code> <description>Domain not registered</description> </domain> <domain name="domain3.com"> <code>0</code> <description>Successfully deleted</description> </domain> </response>

4.2.1 <response version=”1.0” requestid="REQUEST-123456">

This marks the beginning of the response structure. The end is marked by the last line

</response>

The requestid is the ID submitted with the request structure.

4.2.2 <status>

The status node contains information about the status of corresponding operation. The code is result code (0 is success) and description is text description of the status.

In response node status is the status of whole request. In domain nodes status is the status for specified domain operation.