Search in this section

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To import domains and other objects in our system comfortably and without problems, you have to deliver the domain data in the following XML format. The encoding has to be UTF-8.

Panel
titleColor#FFFFFF
titleBGColor#E44313
titleTable of Contents

Table of Contents
outlinetrue
stylenone

Introduction

In the following we show you the valid XMLformat for all objects, which can be imported:

  • Domain Objects

  • User Objects

  • Transfer-in Objects

  • Transfer-out-Objects

  • Cancelation-Objects

  • Contact-Objects

Explanation of the XML-Keys

The <import> Key

All objects, you want to import, have to be enclosed by the <import> key.


Example-Code <import>-Key:

Code Block
languagexml
<?xml version='1.0' encoding='utf-8' ?>
<import>
<owner></owner>
<domain></domain>
<domain></domain>
…
<user> </user>
<user> </user>
…
<transfer-in> </transfer_in>
<transfer-in> </transfer_in>
…
<transfer-out> </transfer-out>
<transfer-out> </transfer-out>
…
<cancelation> </cancelation>
<cancelation> </cancelation>
…
<contact> </contact>
<contact> </contact>
…
</import>


The <owner> Block

This is the global owner block. If an object includes an own <owner> block, it will overwrite this global one.


Example-Code <owner> Block:

Code Block
languagexml
<owner>
<user></user>
<context></context>
</owner>

Key

Occurs

Format

Description

owner

1

string

Owner of the objects

owner / user

1

string

User name and context:

all objects will be imported with, if not individually overwritten.

owner/ context

1

string



The <domain> Block

Example-Code <domain> Block:

Code Block
languagexml
<domain>
<owner>
<user></user>
<context></context>
</owner>
<name>example.com</name>
<authinfo>jhretu45t</authinfo>
<registry_status>ACTIVE<registry_status>
<nserver>
<name>ns1.example.com</name>
<ip>127.0.0.1</ip>
</nserver>
<nserver>
<name>ns2.example.net</name>
</nserver>
<domain_create>1995-12-31</domain_create>
<domain_expire>2009-12-31</domain_expire>
<ownerc>4123424</ownerc>
<adminc>4352436</adminc>
<techc>524514</techc>
<zonec>234325</zonec>
</domain>

Key

Occurs

Format

Description

domain

1 - n



domain / owner

0 - 1


Owner of the domain (overwrites globalblock)

domain / owner / user

1

string

User name 

domain / owner/ context

1

string

User context

domain / name

1

string

Domain name

domain / authinfo

0 – 1*

string

AuthInfo  for the domain

domain / registry_status

0 – 1*

enum

Sets status of domain.

  • Lock = The domain is protected against updates and transfer
  • Hold = the domain is registered but not connected (Example: resellers can set this status e.g. if a client did not pay.)
  • Hold-Lock = the domain ist registered but not connected; it's also protected against transfer. 




  • Active = Domain will be unlocked

domain / nserver

1 - 8 *



domain / nserver / name

1

string

Name of the name server (host name format)

domain / nserver / ip

0 - 1 *

ip

Name server IP only for GLUE records; for GLUE records its mandatory.

domain / nsentry 

0 - 5 *

string

Nsentry can only be provided for .DE; if nsentry is used, nserver is not allowed.

domain / domain_create

1

date time

The creation date of the domain

domain / domain_expire

1

date time

The expire date of the domain

domain / ownerc

1

contact-id

Owner contact (ID of contact)

domain / adminc

0 - 1 *

contact-id

Administrative contact (ID of contact)

domain / techc

0 - 1 *

contact-id

Technical contact (ID of contact)

domain / zonec

0 - 1 *

contact-id

Zone administrator (ID of contact)



The <user > Block

Example-Code <user> Block:

Code Block
languagexml
<user>
<user></user>
<context></context>
<owner>
<user></user>
<context></context>
</owner>
<email>email@example.com</email>
<password>jhretu45t</password>
<language>en</language>
</user>

Key

Occurs

Format

Description

user

1 - n



user / user

1

string

Name of the user

user / context

1

string

Context of the user

user / owner

1


Parent (overwrites global block)

user / owner / user

1

string

Name of the parent

user / owner / context

1

string

Context of the parent

user/ email

1

string

Email address of the user

user / password

1

string

Password of the user

user / language

0 - 1

enum

Language of the interface and the system messages

  • de
  • en

Default: de, if not specified



The <transfer_in > Block

Example-Code <transfer_in>:

Code Block
languagexml
<transfer_in>
<owner>
<user></user>
<context></context>
</owner>
<domain>example.com</domain>
<authinfo>jhretu45t</authinfo>
<nserver>
<name>ns1.example.com</name>
<ip>127.0.0.1</ip>
</nserver>
<nserver>
<name>ns2.example.net</name>
</nserver>
<start_date>2008_08_15</start_date>
<ownerc>4123424</ownerc>
<adminc>4352436</adminc>
<techc>524514</techc>
<zonec>234325</zonec>
</transfer_in>

Key

Occurs

Format

Description

transfer_in

0 - n



transfer_in / owner

0 - 1


Owner of the domain

transfer_in / owner / user

1

string

User name and context of the target domain optional

transfer_in / owner/ context

1

string

transfer_in / domain

1

string

Domain name

transfer_in / authinfo

0 – 1 *

string

AuthInfo  for the domain

transfer_in / nserver

1 - 8 *



transfer_in / nserver /

name

1

string

Name of the name server (host name format)

transfer_in / nserver / ip

0 - 1 *

ip

Name server IP only for GLUE records; here it is mandatory

transfer_in / nsentry

0 - 5 *

string

Nsentry can only be provided for .de; if nsentry is used, nserver is not allowed.

transfer_in / start_date

1

date time

Start date of the transfer

transfer_in / ownerc

1

contact-id

Owner contact (ID of contact)

transfer_in / adminc

0 - 1 *

contact-id

Administrative contact (ID of contact)

transfer_in / techc

0 - 1 *

contact-id

Technical contact (ID of contact)

transfer_in / zonec

0 - 1 *

contact-id

Zone administrator (ID of contact)



The <transfer_out> Block 

Transfer out objects are running transfer outs. Of course, the domain objects, the transfer outs refer to, have to exist. 

Example-Code <transfer_out>:

Code Block
languagexml
<transfer_out>
<domain>domainname.tld</domain>
<start_date>2008-08_15</start_date>
<end_date>2008-08_20</end_date>
</transfer_out>

Key

Occurs

Format

Description

transfer_out

0 – n



transfer_out / domain

1

string

The domain name. It refers to respective domain name block.

transfer_out / start_date

1

date time

The start date of the transfer

transfer_out / end_date

1

date time

The end date of the transfer



The <cancelations> Block

Cancelations objects are running cancelations. Of course, the domain objects, the cancelations refer to, have to exist.

Example-Code <cancelations>:

Code Block
languagexml
<cancelations>
<domain>domainname.tld</domain>
<type>delete</type>
<execdate>2009-01-01</execdate>
<disconnect>1</disconnect>
<gaining_registrar>all</gaining_registrar>
</cancelations>

Key

Occurs

Format

Description

cancelations

0 - n



cancelations / domain

1

string

The domain name. It refers to respective domain name block.

cancelations / type

1

enum

The type of cancelation Values are:

  • delete
  • preack
  • transit

cancelations / execdate

1

string

The execution date of the cancelation Values are:

  • date; format YYYY-MM-DD
  • expire

cancelations / disconnect

0 - 1

enum

Specifies if the domain should be disconnected.

  • 0 = no 
  • 1 = disconnection

Only for transit. In this case it is required, occurs = 1.

cancelations / gaining_registrar

0 - 1

string

The registrar, the domain will be transferred to. 

Values are:

  • all
  • the specific registrar tag (e.g. DENIC-104, INTERNETX-DE)

Only for preack. In this case it is required, occurs = 1.

Only for .de and .uk


The <contact> Block

Example-Code <contact>:

Code Block
languagexml
<contact>
<id>3123123</id>
<owner>
<user></user>
<context></context>
</owner>
<fname>firstname</fname>
<lname>lastname</lname>
<organization>organization GmbH</organization>
<title>Dr.</title>
<type>PERSON</type>
<protection>A</protection>
<address>address line 1</address>
<address>address line 2</address>
<address>address line 3</address>
<pcode>postal code</pcode>
<city>city</city>
<country>country</country>
<state>state</state>
<email>email@example.com</email>
<phone>+49-123-123</phone>
<fax>+49-123-124</fax>
<remarks>free text 1</remarks>
<remarks>free text 2</remarks>
<nic_handle>
<tld>de</tld>
<type>all </type>
<ref>DENIC-104-34354</ref>
</nic_handle>
<nic_handle>
</nic_handle>
</contact>



Key

Occurs

Format

Description

contact

1 - n



contact / id

1

any (numeric recommended)

Reference number, used by the contacts in the objects.

contact / owner

0 - 1


Owner of the domain

contact / owner / user

1

string

User name and context of the target domain optional

contact / owner/ context

1

string

contact / fname

1

string

First name

contact / lname

1

string

Last name

contact / organization

0 - 1

string

Organization

contact / title

0 - 1

string

Title

contact / type

0 - 1 

enum

The contact type  Values are:

  • PERSON
  • ORG
  • ROLE

Default is PERSON.

contact / protection

1

enum

Data, to be displayed in the whois.

  • A: all (default)
  • B: Some data will not be displayed in whois. (Referring to registry)

contact / address

1 - n

string

Street

contact / pcode

1

string

Postal code

contact / city

1

string

City

contact / country

1

cc

Country (ISO 3166 Country Code)

contact / state

0 - 1

string

State

contact / email

0 - 1 *)

email

Email address

contact / phone

0 - 1 *)

phone

Telephone number format: +49-123-123

contact / fax

0 - 1 *)

phone

Fax number format: +49-123-123

contact / remarks

0 - n

string

Remarks

contact / nic_handle

0 - n


The NIC handle

contact / nic_handle / tld

1

tld

The top level domain, lower case, see

http://www.iana.org/domains/root/db/

contact / nic_handle / type

1

enum

The handle type . Values are:

  • all
  • ownerc
  • adminc
  • techc
  • zonec

It depends on the registry which type is permitted. 

contact / nic_handle / ref

1

string

The NIC handle

*) Depends on the registry 


Handle Extensions:

Key

Occurs

Format

Description

contact / extension / gender

0 - 1 *)

enum

gender

  • “” default
  • M
  • F

contact / extension / domicile_address

0 - 1 *)

string

Domicile address, street (only .nl)

contact / extension / domicile_pcode

0 - 1 *)

string

Domicile address, postal code (only .nl)

contact / extension / domicile_city

0 - 1 *)

string

Domicile address, town (only .nl)

contact / extension / domicile_housenr

0 - 1 *)

string

Domicile address, house number (only .nl)

contact / extension / domicile_housenr_ext

0 - 1 *)

string

Domicile address, house number extension (only .nl)

contact / extension / travel_uin

0 - 1 *)

string

Travel Unique Identifying Number (only .travel)

contact / extension / idnumber

0 - 1 *)

string

Identification number of the personal id card

contact / extension / vatnumber

0 - 1 *)

string

Vat number

contact / extension / trademark_name

0 - 1 *)

string

Trademark name

contact / contact / extension / trademark_number

0 - 1 *)

string

Trademark number

contact / extension / trademark_country

0 - 1 *)

cc

Country, where the trademark is valid  (ISO 3166 Country Code)

contact / extension / trademark_regdate

0 - 1 *)

string

Registration date of the trademark

contact / extension / trademark_appdate

0 - 1 *)

date

Application date of the trademark (YYYY-MM-DD)

contact / extension / companynumber

0 - 1 *)

string

Company number 

contact / extension / birthday

0 - 1 *)

date

Date of birth (YYYY-MM-DD)

contact / extension / birthplace

0 - 1 *)

string

Place of birth

contact / extension / birthcountry


cc

Country of birth (ISO 3166 Country Code)

contact / extension / cat_ens_auth_id

0 - 1 *)

string

Catalan authentication ID (only .cat)

contact / extension / cat_ens_key

0 - 1 *)

string

ENS key (only .cat)

contact / extension / cat_intended_use

0 - 1 *)

string

Description of the intended use of the domain (only .cat).

contact / extension / aero_ens_auth_id

0 - 1 *)

string

Aviation authentication ID (only .aero)

contact / extension / aero_ens_key

0 - 1 *)

string

ENS key (only .aero)

*) Depends on the registry


Addendum

Example XML-Code

Code Block
languagexml
<domain>
<owner>
<user></user>
<context></context>
</owner>
<name>example.com</name>
<authinfo>jhretu45t</authinfo>
<registry_status>ACTIVE<registry_status>
<nserver>
<name>ns1.example.com</name>
<ip>127.0.0.1</ip>
</nserver>
<nserver>
<name>ns2.example.net</name>
</nserver>
<domain_create>1995-12-31</domain_create>
<domain_expire>2009-12-31</domain_expire>
<ownerc>4123424</ownerc>
<adminc>4352436</adminc>
<techc>524514</techc>
<zonec>234325</zonec>
</domain>
<domain>
<!--
...further blocks
-->
</domain>
<user>
<user></user>
<context></context>
<owner>
<user></user>
<context></context>
</owner>
<email>email@example.com</email>
<password>jhretu45t</password>
<language>en</language>
</user>
<user>
<!--
...further blocks
-->
</user>

<transfer_in>
<owner>
<user></user>
<context></context>
</owner>
<domain>example.com</domain>
<authinfo>jhretu45t</authinfo>
<nserver>
<name>ns1.example.com</name>
<ip>127.0.0.1</ip>
</nserver>
<nserver>
<name>ns2.example.net</name>
</nserver>
<start_date>2008_08_15</start_date>
<ownerc>4123424</ownerc>
<adminc>4352436</adminc>
<techc>524514</techc>
<zonec>234325</zonec>
</transfer_in>
<transfer_in>
<!--
...further blocks
-->
</transfer_in>
<transfer_out>
<domain>domainname.tld</domain>
<start_date>2008-08_15</start_date>
<end_date>2008-08_20</end_date>
</transfer_out>
<transfer_out>
<!--
...further blocks
-->
</transfer_out>
<cancelations>
<domain>domainname.tld</domain>
<type>delete</type>
<execdate>2009-01-01</execdate>
<disconnect>1</disconnect>
<gaining_registrar>all</gaining_registrar>
</cancelations>
<cancelations>
<!--
...further blocks
-->
</cancelations>
<contact>
<id>3123123</id>
<owner>
<user></user>
<context></context>
</owner>
<fname>firstname</fname>
<lname>lastname</lname>
<organization>organization GmbH</organization>
<title>Dr.</title>
<type>PERSON</type>
<protection>A</protection>
<address>address line 1</address>
<address>address line 2</address>
<address>address line 3</address>
<pcode>postal code</pcode>
<city>city</city>
<country>country</country>
<state>state</state>
<email>email@example.com</email>
<phone>+49-123-123</phone>
<fax>+49-123-124</fax>
<remarks>free text 1</remarks>
<remarks>free text 2</remarks>
<nic_handle>
<tld>de</tld>
<type>all </type>
<ref>DENIC-104-34354</ref>
</nic_handle>
<nic_handle>
</nic_handle>
</contact>
<contact>


The Formats

string

Character string

date time

(SQL-Format) „YYYY-MM-DD hh:mm:ss“

enum

Select one of the list entries

cc

Country code (ISO 3166 Country Code)

tld

Top Level Domain (see http://www.iana.org/domains/root/db/)

ip

IP format (000.000.000.000)

phone

+49-123-123

email

A valid email address (local-part@domain-part, z. B. user@example.com)