EPP API Documentation - Realtime Register! · PDF fileEPP API Documentation, V2.0, Juli 2013 ... 00000030 6F 6E 65 3D 22 6E 6F 22 - 20 3F 3E 3C 65 70 70 20 one="no" ?>

EPP API Documentation

Document version: 2.0Date: July 10th, 2013

EPP API Documentation, V2.0, Juli 2013

3Copyright © 2013, Realtime Register B.V.

Table of Contents

1. Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53. Generic Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

3.1 Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83.1.1 Types.Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83.1.2 Types.Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.1.3 Types.EPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133.1.4 Types.EPPcom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143.1.5 Types.XSI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

3.2 Response Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.3 EPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

3.3.1 EPP.Greeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183.3.2 EPP.Hello . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193.3.3 EPP.Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

3.3.3.1 EPP.Command.Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213.3.3.2 EPP.Command.Logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223.3.3.3 Epp.Command.Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233.3.3.4 EPP.Command.Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253.3.3.5 EPP.Command.Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253.3.3.6 EPP.Command.Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253.3.3.7 EPP.Command.Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263.3.3.8 EPP.Command.Renew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263.3.3.9 EPP.Command.Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263.3.3.10 EPP.Command.Trade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273.3.3.11 EPP.Command.Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

3.3.4 EPP.Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283.3.4.1 1000 Command completed successfully . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303.3.4.2 1001 Command completed successfully - action pending . . . . . . . . . . . . . . . . . . . . 303.3.4.3 2000 Unknown command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303.3.4.4 2001 Command syntax error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313.3.4.5 2101 Unimplemented command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313.3.4.6 2104 Billing failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323.3.4.7 2200 Authentication error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323.3.4.8 2400 Command failed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

4. Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344.1 Contact.Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354.2 Contact.Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384.3 Contact.Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434.4 Contact.Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474.5 Contact.Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

5. Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515.1 Domain.Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525.2 Domain.Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555.3 Domain.Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605.4 Domain.Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635.5 Domain.Renew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675.6 Domain.Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695.7 Domain.Trade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745.8 Domain.Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75



1. Changelog1.0 Initial release

1.1 Updated country code list in 3.1.1

1.2 Added optional authInfo for Domain.Trade

2.0

Changed naming from dealer to customer2: Session timeout of 10 minutes is now enforced3.1.1: "contact:mailType" validation now checks for the presence of a tld3.1.1: Updated country code list3.1.2, 5.2, 5.3, 5.4, 5.5: Added dns template configuration3.3.3.1: Added "clUser" to login command3.3.3.3: Added message polling4.2, 4.3, 4.4: Gender and language have been deprecated as contact attributes4.2: The Repository Object Identifier (ROID) values of all contact objects have been changed during migration5.2: The Repository Object Identifier (ROID) values of all domain objects have been changed during migration5.6: Transfers between customers are now possible



2. IntroductionRealtime Register offers an XML based interface to allow customer to create programs that enable users to be able to communicateinteractively with the automatic registration system. An IETF working group (Provisioning Registry Protocol) has already defined astandard to support this type of interface, i.e. Extensible Provisioning Protocol (EPP). Realtime Register has implemented a systembased on this protocol.

EPP is a protocol for registering and managing domain names (and not necessarily only domain names) in a generic and way. Eachregistrar has its own procedures; therefore some parts will apply while others will have different approach. Because of this the designersof EPP have made it 'extensible' from the very beginning. Due to some fundamental differences in the conceptual model and due to somedifferences in the data format of some fields, some compromises have been made. The Realtime Register adaption of the EPP protocolis specifically made to fit the Realtime Register systems requirements.

This document describes the kind of transactions required to set up in order to communicate with the XML interface. XML schema is away of exactly describing the possible content of a XML document. As such, we refer to the schema definitions that describe EPP'ssyntax. The received XML documents are expected to be valid. Therefore you should validate your document according to the providedschemas. The Realtime Register EPP system will validate the received XML document using a validating XML parser first beforehandling it. Invalid documents will generate an error message to the sender. Avoidable error messages create extra load on the serverand will therefore deteriorate the system’s performance.

Versioning

The EPP system is designed to support multiple versions of the EPP interface at once. All available versions are listed by the server inthe , the version that is send through the command is the version that is used for the session. We will inform all<greeting> <login>customers in advance of a new version of the EPP interface so you have the time to implement the changes and test them in the OT&Eenvironment. After the release we will keep on supporting the old version for at least two months and we will monitor for customers whoare still using an old version before discontinuing it.

EPP versions have a major and a minor version number. Small changes will result in an increase of the minor version number (i.e. 1.0,1.1, xxx). Late changes in the overall data model will result in a major version number increase and the minor version number to be reset(i.e. 1.2, 2.0, xxx). This document will be numbered accordingly to the EPP version number, changes in documentation without any EPPversion change will result in an increasing capital letter following the EPP version number (e.g. 1.0, 1.0B, 1.0C, 1.1, 1.1B, ...).

Username and Password

In order to be able to access the EPP system, you need to use the username and password chosen when you registered as a customer.

Connection

The EPP connection to the EPP system is SSL encrypted. If you want to connect to the YourSRS EPP server you should use thefollowing information:

Production

Hostname: epp.api.yoursrs.comPort: 700

Operational Test and Evaluation

Hostname: epp.api.yoursrs-ote.comPort: 700

The server will then send a upon establishment of the connection/session.<greeting>

Transport

The transport mechanism for the EPP interface is as described in RFC 3734. A short description of this RFC is provided here, for thecomplete RFC we refer to .http://www.ietf.org/rfc/rfc3734.txt

Session Management

Mapping EPP session management facilities onto the TCP service is straight forward. An EPP session first requires the creation of a TCPconnection between two peers, one that initiates the connection request and one that responds to the connection request. The initiatingpeer is called the "client", and the responding peer is called the "server".

http://www.ietf.org/rfc/rfc3734.txt



To start an EPP session, the client issues an active OPEN call, specifying the TCP port number 700. The server responds with a passiveOPEN call, which the client must acknowledge to be able to establish the connection. The EPP server will then returns a to<greeting>the client after the TCP session is established.

An EPP session is usually ended by the client by issuing a command. When the server receives a command it will<logout> <logout>terminate the EPP session and close the TCP connection through an active CLOSE call. The client must respond with a passive CLOSEcall. EPP sessions that are inactive for more than 10 minutes will be ended by the server, issuing an active CLOSE call. The server mayalso close TCP connections for any maintenance purposes. Peers SHOULD respond to an active CLOSE call with a passive CLOSE call.The closing peer MAY issue an ABORT call if the responding peer does not respond to the active CLOSE call.

Message Exchange

With the exception of the EPP server greeting, EPP messages are initiated by the EPP client in the form of EPP commands. The serverreturns an EPP response to an EPP command on the same TCP connection that is carrying the command. If a response could not bereturned to the client because of a prematurely closed TCP connection, the server will execute the command anyway.The results of the command can be requested at the Realtime Register support team with an e-mail to [email protected] sure you mention the particular . EPP commands are idempotent, so processing a command more than once will produceclTRIDthe same net effect on the repository as to successfully processing the command one time only.

Each EPP data unit must contain a single EPP message. Commands are processed independently and in the same order as sent fromthe client.

General client-server message exchange

Client Server | | | Connect | | >>------------------------------->> | | | | Send Greeting | | <<-------------------------------<< | | | | Send <login> | | >>------------------------------->> | | | | Send Response | | <<-------------------------------<< | | | | Send Command | | >>------------------------------->> | | | | Send Response | | <<-------------------------------<< | | | | Send <logout> | | >>------------------------------->> | | | | Send Response & Disconnect | | <<-------------------------------<< | | |

Data Unit Format

The data field of the TCP header MUST contain an EPP data unit. The EPP data unit contains two fields: a 32-bit header that describesthe total length of the data unit, and the EPP XML instance. The total size of a data unit may not exceed 65536 bytes (64Kb).

EPP Data Unit Format (one tick mark represents one bit position)

0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Total Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | EPP XML Instance | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+//-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+



Total Length (32 bits)The total length of the EPP data unit measured in octets in network (big Endean) byte order. The octets which are contained in this fieldmust be included in the total length calculation.

EPP XML Instance (variable length)The EPP XML instance carried in the data unit.

Hexdump of data unit including data unit size

00000000 00 00 01 32 3C 3F 78 6D - 6C 20 76 65 72 73 69 6F ...2<?xml versio 00000010 6E 3D 22 31 2E 30 22 20 - 65 6E 63 6F 64 69 6E 67 n="1.0" encoding 00000020 3D 22 55 54 46 2D 38 22 - 20 73 74 61 6E 64 61 6C ="UTF-8" standal 00000030 6F 6E 65 3D 22 6E 6F 22 - 20 3F 3E 3C 65 70 70 20 one="no" ?><epp 00000040 78 6D 6C 6E 73 3D 22 68 - 74 74 70 3A 2F 2F 77 77 xmlns="http://ww 00000050 77 2E 79 6F 75 72 73 72 - 73 2E 63 6F 6D 2F 78 6D w.yoursrs.com/xm 00000060 6C 2F 65 70 70 2F 65 70 - 70 2D 31 2E 30 22 20 78 l/epp/epp-1.0" x 00000070 6D 6C 6E 73 3A 65 70 70 - 3D 22 68 74 74 70 3A 2F mlns:epp="http:/ 00000080 2F 77 77 77 2E 79 6F 75 - 72 73 72 73 2E 63 6F 6D /www.yoursrs.com 00000090 2F 78 6D 6C 2F 65 70 70 - 2F 65 70 70 2D 31 2E 30 /xml/epp/epp-1.0 000000A0 22 20 78 6D 6C 6E 73 3A - 78 73 69 3D 22 68 74 74 " xmlns:xsi="htt 000000B0 70 3A 2F 2F 77 77 77 2E - 77 33 2E 6F 72 67 2F 32 p://www.w3.org/2 000000C0 30 30 31 2F 58 4D 4C 53 - 63 68 65 6D 61 2D 69 6E 001/XMLSchema-in 000000D0 73 74 61 6E 63 65 22 20 - 78 73 69 3A 73 63 68 65 stance" xsi:sche 000000E0 6D 61 4C 6F 63 61 74 69 - 6F 6E 3D 22 68 74 74 70 maLocation="http 000000F0 3A 2F 2F 77 77 77 2E 79 - 6F 75 72 73 72 73 2E 63 ://www.yoursrs.c 00000100 6F 6D 2F 78 6D 6C 2F 65 - 70 70 2F 65 70 70 2D 31 om/xml/epp/epp-1 00000110 2E 30 20 65 70 70 2D 31 - 2E 30 2E 78 73 64 22 3E .0 epp-1.0.xsd"> 00000120 3C 21 2D 2D 20 2E 2E 2E - 20 2D 2D 3E 3C 2F 65 70 </ep 00000130 70 3E p>

Encoding

All XML documents must use UTF-8 encoding.The server will ignore encoding specified in the XML declaration except UFT-8. Any otherencoding may result in invalid data being stored in the database. It is possible that other command will fail over this because the data isneeded but invalid.

XML entities must be used to encode data, the entities are:

Enitity Character Description

"" quotation mark

&& ampersand

'` apostrophe

<< less-than sign

>> greater-than sign



3. Generic Information

TypesAll data has a type of defining its own restrictions, these types are defined in the XSD's. Each type has a “name space” and a “name”. the“name space” is the part before the ":" while the “name” is the part after. If no name space is given then the default name space will begiven is . The name space and name are shown in the lower part of each element in the scheme. These types are explained here,XSIthey are grouped by name space. For each element there is a purpose, restriction and source given. The purpose explains what the typeis used for and where it is used. The Restriction gives a textual explanation of the restrictions of this type. The Source is the definition inthe XSD defining the type and it restrictions.

Types.Contact

Type Purpose Restriction/Source

e164Type Voiceand faxnumbers

"+<country>.<number>" with a total minimum length of 4 and maximum length of 17, <country> is theE164 country number with a minimum length of 1 and a maximum length of 3, <number> has aminimum length of 1 and a maximum length of 14.

mailType Emailaddress

Only valid email adressess are allowed

genderType Thegenderof acontact

Possible values are "male", "female" or not defined

langType Preferredlanguage

Passible values are "NL", "EN" or not defined

7.6.5.4.3.2.1. <simpleType name="e164Type">

<restriction base="token"><minLength value="4"/><maxLength value="17"/><pattern value="\+[0-9]{1,3}\.[0-9]{1,14}"/>

</restriction></simpleType>

7.6.

5.4.3.2.1. <simpleType name="mailType">

<restriction base="eppcom:minTokenType"><minLength value="4"/><maxLength value="100"/><pattern value="([a-zA-Z0-9_.\-]+@[a-zA-Z0-9_.\-]+

\.[a-zA-Z]{2,6})"/></restriction>

</simpleType>

7.6.5.4.3.2.1. <simpleType name="genderType">

<restriction base="token"><enumeration value="male"/><enumeration value="female"/><enumeration value=""/>


7.6.5.4.3.2.1. <simpleType name="langType">

<restriction base="token"><enumeration value="NL"/><enumeration value="EN"/><enumeration value=""/>




postalLineType Requiredcontactdata

Minimum length 1, Maximum length 255

optPostalLineType Optionalcontactdata

Maximum length 255

pcType Postalcode

Minimum length 1, Maximum length 16

ccType Countrycode

All officials 2 capital letter country codes are allowed, they are: "AD", "AE", "AF", "AG", "AI", "AL","AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH","BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD","CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE","DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO","FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS","GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR","IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ","LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG","MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY","MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF","PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU","RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS","ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR","TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU","WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"

6.5.4.3.2.1. <simpleType name="postalLineType">

<restriction base="normalizedString"><minLength value="1"/><maxLength value="255"/>


5.4.3.2.1. <simpleType name="optPostalLineType">

<restriction base="normalizedString"><maxLength value="255"/>


6.5.4.3.2.1. <simpleType name="pcType">

<restriction base="token"><minLength value="1"/><maxLength value="16"/>


7.6.5.

4.3.2.1. <simpleType name="ccType">

<restriction base="token">




statusType Status ofa contact

Currently the only status a contact can have is "ok"

13.12.11.10.09.08.07.06.

05.

04.03.02.01. <complexType name="statusType">

<simpleContent><extension base="normalizedString">

<attribute name="s" type= "contact:statusValueType" use="required"

/><attribute name="lang" type="language"

default="en"/></extension>

</simpleContent></complexType><simpleType name="statusValueType">

<restriction base="token"><enumeration value="ok"/>




Types.Domain


nameType Domainname

The domain name consists of two or three parts, the parts are separated by a ".". In general the firstpart can contain the characters "a-z", "0-9" and "-" with a minimum length of 1 and a maximum lengthof 255 characters. For each TLD there are specific restrictions for this part of the domain. Detailedinformation about the specifics for each TLD is available at https://www.realtimeregister.com/domains

. The second and third part can contain the characters "a-z" with a minimum length of 1 and amaximum length of 6, only valid TLDs (1 part) and SLDs (2 parts) are allowed in these parts. Detailedinformation about the available TLD and SLD’s is also available at

https://www.realtimeregister.com/domains

.

statusType Domainname status

The status of a domain name can be one of these statuses: "ok", "pendingcreate", "pendingdelete","pendingrenew", "pendingtrade", "pendingupdate", "requested", "pendingtransfer"

renewunitType Specificationof the renewsetting.

The renew setting of a domain can be "y" for yes, "n" for no or unspecified for default.

7.6.

5.4.3.2.1. <simpleType name="nameType">

<restriction base="token"><minLength value="4"/><maxLength value="255"/><pattern value=

"([0-9a-z\-]{1,255}(\.([a-z]{1,6})){1,2})"/></restriction>

</simpleType>

20.19.18.17.16.15.14.13.12.11.10.09.08.07.06.

05.

04.03.02.01. <complexType name="statusType">

<simpleContent><extension base="normalizedString">

<attribute name="s" type= "domain:statusValueType" use="required"/>

<attribute name="lang" type="language"default="en"/>

</extension></simpleContent>

</complexType><simpleType name="statusValueType">

<restriction base="token"><enumeration value="ok"/><enumeration value="pendingcreate"/><enumeration value="pendingdelete"/><enumeration value="pendingrenew"/><enumeration value="pendingtrade"/><enumeration value="pendingupdate"/><enumeration value="pendingtransfer"/><enumeration value="requested"/>


7.6.5.4.3.2.1. <simpleType name="renewunitType">

<restriction base="token"><enumeration value="y"/><enumeration value="n"/><enumeration value=""/>






hostType A hostname A hostname consists of multiple parts separated by a ".", at least 2 parts are required. The last partmay consist of characters "a-z" with a minimum length of 2 and a maximum length of 6. All other partsmay consists of characters "a-z", "0-9" and "-" with a minimum length of 1 and a maximum length of255. The total length may not exceed 255 characters.

addrType A IPv4address

Only valid IPv4 addresses are allowed

trStatusType Transferstatus

One of the values: "rejectedprov", "rejecteddef", "rejected", "pendingfoa", "failed", "completed","approvedprov", "approveddef", "approved", "cancelled", "requested", "pendingwhois", "pending"

7.6.

5.4.3.2.1. <simpleType name="hostType">

<restriction base="token"><maxLength value="255"/><minLength value="4"/><pattern value=

"([0-9a-z\-]{1,255}\.)*[0-9a-z\-]{1,255}\.[a-z]{2,6}"/>


23.22.21.20.19.18.17.16.15.14.

13.

12.11.10.09.08.07.06.05.

04.03.02.01. <complexType name="addrType">

<simpleContent><extension base="domain:addrStringType">

<attribute name="ip" type="domain:ipType"default="v4"/>


</complexType><simpleType name="addrStringType">

<restriction base="token"><minLength value="3"/><maxLength value="45"/><pattern

value="(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9])\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[0-9])"/>

</restriction></simpleType><simpleType name="ipType">

<restriction base="token"><enumeration value="v4"/>


17.16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <simpleType name="trStatusType">

<restriction base="token"><enumeration value="rejectedprov"/><enumeration value="rejecteddef"/><enumeration value="rejected"/><enumeration value="pendingfoa"/><enumeration value="failed"/><enumeration value="completed"/><enumeration value="approvedprov"/><enumeration value="approveddef"/><enumeration value="approved"/><enumeration value="cancelled"/><enumeration value="requested"/><enumeration value="pendingwhois"/><enumeration value="pending"/>




templateType DNSTemplate

The handle of the DNS template with an attrubute to indicate if the template should be linked

Types.EPP

Type Purpose Restriction / Source

pwType Passwords, <pw> and <newPW> in <login> Minimum length is 6 and the maximum length is 16 characters.

trIDStringType Transaction identifiers, clTRID an svTRID in and <command> <response>

Minimum length is 3 and the maximum length is 64 characters.

versionType Server version numbering Consists of a major and a minor version number separated by a".", currently only 1.0 is allowed.

7.6.5.

4.3.2.1. <complexType name="templateType">

<simpleContent><extension base="eppcom:clIDType">

<attribute name="link" type= "domain:templateLinkType" use="required"

/></extension>

</simpleContent></complexType>

6.5.

4.

3.2.1. <simpleType name="pwType">

<restriction base="token"><minLength value="6"

/><maxLength value="16"

/></restriction>

</simpleType>

6.5.

4.

3.2.

1. <simpleType name="trIDStringType">

<restriction base="token"><minLength value="3"

/><maxLength value="64"

/></restriction>

</simpleType>

6.5.

4.

3.2.1. <simpleType name="versionType">

<restriction base="token"><pattern value=

"[1-9]+\.[0-9]+"/><enumeration value=

"1.0"/></restriction>

</simpleType>



msgType A server message A non restricted string

Types.EPPcom


clIDType Object identifier contactsand customers

Allowed characters are "a-z", "A-Z", "0-9", "-", "_", "@" and "." with a minimum length of3 and a maximum length of 40 characters.

reasonType Reason for non availableobject

Minimum length of 1 and maximum length of 255 characters.

roidType Server object identifier "<id>-<type>" where id is the object ID and type is the DOMAIN or CONTACT.

7.6.5.

4.

3.2.1. <complexType name="msgType">

<simpleContent><extension base=

"normalizedString">

<attribute name ="lang" type

="language"default="en"/>


</complexType>

7.6.5.4.

3.2.1. <simpleType name="clIDType">


"[a-zA-Z0-9\-_@\.]{3,40}"/><minLength value="3"/><maxLength value="40"/>


13.12.11.10.09.08.07.06.05.

04.

03.02.01. <complexType name="reasonType">

<simpleContent><extension base=

"eppcom:reasonBaseType"><attribute name="lang" type=

"language"/></extension>

</simpleContent></complexType><simpleType name="reasonBaseType">

<restriction base="token"><minLength value="1"/><maxLength value="255"/>


5.4.

3.2.1. <simpleType name="roidType">


"\d{1,10}-(DOMAIN|CONTACT)"/></restriction>

</simpleType>



pwAuthInfoType Object authenticationpassword

Minimum length of 1 and maximum length of 64 characters.

Types.XSI

Type Purpose Source

dateTime Representation of a date and time http://www.w3.org/TR/xmlschema-2/#dateTime

language Language specification http://www.w3.org/TR/xmlschema-2/#language

date Representation of a date http://www.w3.org/TR/xmlschema-2/#date

6.5.4.3.2.1. <simpleType name="pwAuthInfoType">

<restriction base="normalizedString"><minLength value="1"/><maxLength value="64"/>


http://www.w3.org/TR/xmlschema-2/#dateTime

http://www.w3.org/TR/xmlschema-2/#language

http://www.w3.org/TR/xmlschema-2/#date



Response CodesAll messages have a result code, a message with the description of the result code and optionally additional error messages.<response>The response codes that can be returned are:

Code Message

1000 Command completed successfully

1001 Command completed successfully; action pending

1300 Command completed successfully; no messages

1301 Command completed successfully; ack to de-queue

1500 Command completed successfully; ending session

2000 Unknown command

2001 Command syntax error

2002 Command use error

2003 Required parameter missing

2004 Parameter value range error

2005 Parameter value syntax error

2100 Unimplemented protocol version

2101 Unimplemented command

2102 Unimplemented option

2103 Unimplemented extension

2104 Billing failure

2105 Object is not eligible for renewal

2106 Object is not eligible for transfer

2200 Authentication error

2201 Authorization error

2202 Invalid authorization information

2300 Object pending transfer

2301 Object not pending transfer

2302 Object exists

2303 Object does not exist

2304 Object status prohibits operation

2305 Object association prohibits operation -

2306 Parameter value policy error

2307 Unimplemented object service

2308 Data management policy violation

2400 Command failed

2500 Command failed; server closing connection

2501 Authentication error; server closing connection

2502 Session limit exceeded; server closing connection



EPPScheme

The root element for all documents is the <epp> element, because this is the root element the document type must be specified in thiselement. The following attributes are required:xmlnsThe root name space, this must be: http://www.yoursrs.com/xml/epp/epp-1.0

xmlns:eppThe URI for the epp name space, this must be: http://www.yoursrs.com/xml/epp/epp-1.0

xmlns:xsiThe URI to the xsi name space, this must be: http://www.w3.org/2001/XMLSchema-instance

xsi:schemaLocationThe schema location for the used namespaces, this must at least include the epp namespace: http://www.yoursrs.com/xml/epp/epp-1.0epp-1.0.xsd

It is also possible to specify the namespaces and schema locations of the contact and domain name space in the epp element, in thiscase it doesn't have to be specified when using the namespace. The following attributes can be specified

xmlns:contactThe URI for the contact name space, this must be: http://www.yoursrs.com/xml/epp/contact-1.0

xmlns:domainThe URI for the domain name space, this must be: http://www.yoursrs.com/xml/epp/domain-1.0

xsi:schemaLocationThe schema location must include the schema locations of any additional namespace, for example:"http://www.yoursrs.com/xml/epp/epp-1.0 epp-1.0.xsd contact-1.0.xsd http://www.yoursrs.com/xml/epp/contact-1.0

domain-1.0.xsd"http://www.yoursrs.com/xml/epp/domain-1.0

Epp root element without additional name space specifications

Epp root element with additional name space specifications

12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd"http://www.yoursrs.com/xml/epp/epp-1.0 ></epp>

http://www.yoursrs.com/xml/epp/epp-1.0


http://www.w3.org/2001/XMLSchema-instance


http://www.yoursrs.com/xml/epp/contact-1.0

http://www.yoursrs.com/xml/epp/domain-1.0









The root element must also contain one of the elements <greeting>, <hello>, <command> or <response>, the purpose and specificationof these elements are described hereafter.

EPP.Greeting

In the <greeting> the server also provides the client with the necessary information to use the EPP interface. The server is the only oneallowed to send the <greeting>. A greeting send from the client will result in an error. The <greeting> is send by the server opon a newconnection and as response to a .<hello>

Scheme

14.13.12.11.10.09.08.

07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:contact=" "http://www.yoursrs.com/xml/epp/contact-1.0xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd [http://www.yoursrs.com/xml/epp/epp-1.0

] contact-1.0.xsd [http://www.yoursrs.com/xml/epp/contact-1.0] domain-1.0.xsd"http://www.yoursrs.com/xml/epp/domain-1.0 >

</epp>











The following information is supplied:

svID: The name of the server, which can be used to identify the server. Possible values are:

"Realtime Register OT&E" For the OT&E environment"Realtime Register" For the production environment

svDate: The current date and time of the server. The available EPP versions on the server.version:

The available languages for the server messages.lang: The available name space URI's.objURI:

Example greeting send by the production server

EPP.Hello

A <hello> can be send to the server by the client to request a .<greeting>

Example

EPP.Command

The <command> is used to perform actions on the server.

Scheme

34.33.32.31.30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd"http://www.yoursrs.com/xml/epp/epp-1.0 ><greeting>

<svID>Realtime Register 1.0</svID><svDate>2005-12-27T09:38:53.0Z</svDate><svcMenu>

<version>1.0</version><lang>en</lang><objURI> ;/http://www.yoursrs.com/xml/epp/contact-1.0&lt objURI><objURI> ;/http://www.yoursrs.com/xml/epp/domain-1.0&lt objURI>

</svcMenu><dcp>

<access><all/>

</access><statement>

<purpose><admin/><prov/>

</purpose><recipient>

<ours/><public/>

</recipient><retention>

<stated/></retention>

</statement></dcp>

</greeting></epp>


<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd"http://www.yoursrs.com/xml/epp/epp-1.0 ><hello/>

</epp>





http://www.yoursrs.com/xml/epp/contact-1.0&lt

http://www.yoursrs.com/xml/epp/domain-1.0&lt







commandContains the commands to be executed, must be one of the these elements: login, logout, check, info, create, update, renew, transfer,trade or delete. These will be explained and specified hereafter.

clTRIDAn optional clTRID element may also be provided, if it is provided the will include the value in the <clTRID> element. This<response>can be used to track and log commands.

Example



EPP.Command.Login

A <login> command is used to login to the EPP server, it can also be used to change the password.

Scheme

clID: The customer, this is the customer handle you have chosen during registration. The user, the user login with which you want to log in. If no user is supplied the user "admin" wil be used.clUser:

The password.pw: Optionally a new password. The <login> command cannot be send after a successful <login> has been processed, thus thenewPW:

password can only be changed at the beginning of the session. The EPP version for this session, currently only "1.0" is allowed.version:

The language for this session, currently only "en" is supported.lang:

Example login

22.21.20.19.18.17.16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd"http://www.yoursrs.com/xml/epp/epp-1.0 ><command>

<clTRID>client-12345</clTRID>

</command></epp>







Example login with password change

A successful <login> will result in a code 1000 with no resData.<response>

The following errors may occur:

2002 Command use errorA successful login command has already been processed

2200 Authentication errorThe <login> could not be processed because of one of the following reasons:

Invalid combination of <clID>, <clUser> and <pw> values.The account has been locked, in this case you will get an additional error.

EPP.Command.Logout

The <logout> command is used to end an EPP session.

The <logout> command has no child elements.

Example logout

18.17.16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<login><clID>customer</clID><clUser>user</clUser><pw>password</pw><options>

<version>1.0</version><lang>en</lang>

</options></login><clTRID>client-12345</clTRID>

</command></epp>

18.17.16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<login><clID>customer</clID><pw>password</pw><newPW>change</newPW><options>

<version>1.0</version><lang>en</lang>

</options></login><clTRID>client-12345</clTRID>

</command></epp>











A successful <login> will result in a code 1500 with no resData and the TCP connection will be closed.<response>

Epp.Command.Poll

The <poll> command is used to check for messages.

Poll Scheme

op: The operation to perform

req: Request messageack: Acknowledge message

mgsID: The message ID

MsgQ Scheme

10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<logout/><clTRID>client-12345</clTRID>

</command></epp>







count: The number of messages in the queue. The identifier of the message.id:

The date the message was queued.qDate: The textual message.msg:

In case of a domain create, renew or transfer notification; additional information will be supplied in the resData element. TheresData:format is documented with the corresponding commands: , , .creData renData trnData

Request message

Example poll request

A successful <poll op="req"> will result in:

a code 1301 with <msgQ> element and optional <resData> element if there is a message<response>a code 1300 if there are no messages<response>

Example <response>

Acknowledge message

Example poll acknowledge

A successful <poll op="req"> will result in a code 1000, if there are any messages left a <msgQ> will be supplied.<response>



<poll op="req" /><clTRID>client-12345</clTRID>

</command></epp>

25.24.23.22.21.20.19.18.17.16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0

xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd"http://www.yoursrs.com/xml/epp/epp-1.0 ><response>

<result code="1301"><msg>Command completed successfully; ack to dequeue</msg>

</result><msgQ count="4" id="12345">

<qDate>2013-01-01T00:00:00.0Z</qDate><msg lang="en">Example message/msg>

</msgQ><resData>

</resData><trID>

<clTRID>client-12345</clTRID><svTRID>yoursrs-12345</svTRID>

</trID></response>

</epp>



<poll op="ack" msgID="12345 /><clTRID>client-12345</clTRID>

</command></epp>















Example <response>

EPP.Command.Check

The <check> command is used to check if an object could be created, it may contain a or .<contact:check> <domain:check>

Example

EPP.Command.Info

The <info> command is used to query the server for information about existing object that is managed by the current user. It shouldcontain either or .<contact:info> <domain:info>

Example

EPP.Command.Create

The <create> command is used to create a new object. It should contain either or .<contact:create> <domain:create>

16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd"http://www.yoursrs.com/xml/epp/epp-1.0 ><response>

<result code="1000"><msg>Command completed successfully</msg>

</result><msgQ count="3" id="12346"/><trID>


</trID></response>

</epp>

15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<check></check><clTRID>client-12345</clTRID>

</command></epp>



<info></info><clTRID>client-12345</clTRID>

</command></epp>















Example

EPP.Command.Update

The <update> command is used to update an existing object managed by the current user. It should contain either or <contact:update>.<domain:update>

Example

EPP.Command.Renew

The <renew> command is used to extend the validity period of an existing object managed by the current user. It contain contain a .<domain:renew>

Example

EPP.Command.Transfer

The <transfer> command is used to change the sponsorship of an existing object. It should contain a .<domain:transfer>

Scheme



<create></create><clTRID>client-12345</clTRID>

</command></epp>



<update></update><clTRID>client-12345</clTRID>

</command></epp>

14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<renew>

</renew><clTRID>client-12345</clTRID>

</command></epp>















Example

EPP.Command.Trade

The <trade> command is used to change the owner of an existing object, it should contain a .<domain:trade>

Example

EPP.Command.Delete

The <delete> command is used to remove an object that is managed by the current user, it should contain either a or <contact:delete>.<domain:delete>

Example

14.13.12.11.10.09.08.



<transfer op="request">

</transfer><clTRID>client-12345</clTRID>

</command></epp>

14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<trade>

</trade><clTRID>client-12345</clTRID>

</command></epp>











EPP.Response

The <response> is used by the server to inform the client about the result of the requested [<command>|RTREPPDOC:EPP.Command.The <response> is exclusively sent by the server. A <response> being sent to the server it will result in a error.

Scheme

*code: *The describing the general result of the action.response code

*msg:*The first <msg> element is the textual representation of the , if the is an error there may be anresponse code response codeadditional <msg> elements with error messages.

msgQ: Contains message queue information, only set after a successful command.<poll>

resData: Some commands need to send additional info to the client if the command was processed successfully, this is done in the<resData> element. <resData> may contain one of the following elements.

<contact:chkData> after a successful command.<contact:check><domain:chkData> after a successful command.<domain:check>



<delete-></delete><clTRID>client-12345</clTRID>

</command></epp>







<contact:infData> after a successful command.<contact:info><domain:infData> after a successful command.<domain:info><contact:creData> after a successful command.<contact:create><domain:creData> after a successful command.<domain:create><domain:renData> after a successful command.<domain:renew><domain:trnData> after a successful command.<domain:transfer>

clTRID: If an <clTRID> element is provided in the this value will be returned in the <clTRID> element of the <response>.<command>This can be used to track and log commands.

This is the server unique identifier, it is needed for support request regarding a specific request.svTRID:

Example <response> code 1000 without <resData> element

Example <response> code 1000 with <resData> element

Example <response> code 2302 without <resData> element and additional error message




</result><trID>


</trID></response>

</epp>

27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.12.11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>



</result><resData>

</resData><trID>


</trID></response>

</epp>











A successfully executed command will result in a with a code 1000 or 1001, except for a command, this will result<response> <logout>in a code 1500. Each command has a set of errors wich it can generate, they are described on a per command basis. There are alsoerrors that are not command specific and can occur anywhere. Descriptions of these response codes is given here.

1000 Command completed successfully

The command has been executed successfully.

Example

1001 Command completed successfully - action pending

The command has been executed successfully but the initiated process has not been completed. This occurs when the commandrequested an asynchronous process; the command has started the process successfully but the process has not yet been completed.The status of the particular object will show an action is pending. After confirmation by the TLD (registry) the status of the object shallchange accordingly. In case the command was rejected, a notification will be send and the changes to the object are reverted.

Example



<result code="2302"><msg>Object exists</msg><msg>Additional error message</msg>

</result><trID>


</trID></response>

</epp>




</result><trID>


</trID></response>

</epp>



<result code="1001"><msg>Command completed successfully; action pending</msg>

</result><trID>


</trID></response>

</epp>















2000 Unknown command

There are several ways this error can be evoked.

No data has been sent to the server, the server will send a code 2000 with additional error message "No input found".<response>

Example

The data sent to the server is valid but does not contain a valid command, for instance when a or is sent to the<greeting> <response>server, the server will send a code 2000.<response>

Example

2001 Command syntax error

The syntax of the command is invalid, additional error messages will be send to specify the error.

Example



<result code="2000"><msg>Unknown command</msg><msg>No input found</msg>

</result><trID>


</trID></response>

</epp>



<result code="2000"><msg>Unknown command</msg>

</result><trID>


</trID></response>

</epp>

16.15.14.13.12.11.10.

09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<result code="2001"><msg>Command syntax error</msg><msg>XML parse exception, line 8, column 1: The input ended before all

started tags were ended. Last tag started was 'epp'</msg></result><trID>


</trID></response>

</epp>















2101 Unimplemented command

The command send to the server is valid but it is not implemented. This can happen if a command is being executed at a TLD that doesnot support the command; additional error messages may be supplied.

Example

2104 Billing failure

There is an insufficient account balance to cover the costs of the requested command.

Example

2200 Authentication error

The requested command requires authentication, you must execute a first.<login>

Example

2400 Command failed



<result code="2101"><msg>Unimplemented command</msg>

</result><trID>


</trID></response>

</epp>



<result code="2104"><msg>Billing failure</msg>

</result><trID>


</trID></response>

</epp>



<result code="2200"><msg>Authentication error</msg>

</result><trID>


</trID></response>

</epp>















The requested command cannot be executed due to an unspecified error, please contact Realtime Register support to track and resolvethe issue.

Example



<result code="2400"><msg>Command failed</msg>

</result><trID>


</trID></response>

</epp>







4. ContactThe contact name space is used to manage the contacts in the system. If the name space is used in a command it needs to be definedwithin the document, this can be done in the root <epp> element or in the first element of the contact name space.

Example of name space definition in root element

Example of name space definition in first contact name space element

15.14.13.12.11.10.09.08.07.

06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:contact=" "http://www.yoursrs.com/xml/epp/contact-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd http://www.yoursrs.com/xml/epp/epp-1.0

contact-1.0.xsd"http://www.yoursrs.com/xml/epp/contact-1.0 ><command>

<check><contact:check>

</contact:check>

</check><clTRID>client-12345</clTRID>

</command></epp>

15.14.13.12.11.10.

09.

08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<check><contact:check xmlns:contact="

"http://www.yoursrs.com/xml/epp/contact-1.0xsi:schemaLocation="http://www.yoursrs.com/xml/epp/contact-1.0

contact-1.0.xsd">

</contact:check></check><clTRID>client-12345</clTRID>

</command></epp>















Contact.CheckThis command checks if a contact ID is available for creation. A <contact:check> command can be used to check multiple contacts atonce. If more than one contact needs to be checked it is much faster to send one <contact:check> command with multiple contactsinstead of to sending multiple <contact:check> commands. There are no limits to the maximum amount of contacts to check, provided thetotal data unit size remains below the maximum size.

Scheme

id: The ID of the contact to be checked.

Example <contact:check> command with one contact

Example <contact:check> command with three contacts

A successful <contact:check> will result in a code 1000 with a <contact:chkData> resData element.<response>

Contact.chkData

The <contact:chkData> element is send by the server in the to a successful command. It supplies the client<response> <contact:check>with the availability information of the contact(s) in the command.<contact:check>

Scheme

15.14.13.12.11.10.

09.





contact-1.0.xsd"><contact:id>contact-1</contact:id>


</command></epp>

18.17.16.15.14.13.12.11.10.

09.





contact-1.0.xsd"><contact:id>contact-1</contact:id><contact:id>contact-2</contact:id><contact:id>contact-3</contact:id>


</command></epp></xml>















For each checked contact a <contact:cd> element is supplied.

idThe id of the checked contact with an attribute "avail" with the value "1" for available or "0" for not available.

reasonIf the contact is not available for any other reason besides it already exists, this element contains the reason it is not available.

Example <response> with a <contact:chkData> element for one contact

Example <response> with a <contact:chkData> element for three contacts

23.22.21.20.19.18.17.16.15.14.13.

12.

11.10.09.08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>


<result code="1000"><msg/>

</result><resData>

<contact:chkData xmlns:contact=""http://www.yoursrs.com/xml/epp/contact-1.0

xsi:schemaLocation="http://www.yoursrs.com/xml/epp/contact-1.0contact-1.0.xsd">

<contact:cd><contact:id avail="1">contact-1</contact:id>

</contact:cd></contact:chkData>

</resData><trID>


</trID></response>

</epp>









29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.

12.



<result code="1000"><msg/>

</result><resData>

<contact:chkData xmlns:contact=""http://www.yoursrs.com/xml/epp/contact-1.0


<contact:cd><contact:id avail="1">contact-1</contact:id>

</contact:cd><contact:cd>

<contact:id avail="0">contact-2</contact:id></contact:cd><contact:cd>

<contact:id avail="1">contact-3</contact:id></contact:cd>

</contact:chkData></resData><trID>


</trID></response>

</epp>









Contact.InfoThis command is used to retrieve details of an existing contact.

Scheme

id:The ID of the contact to request info of

Example <contact:info> command

A successful <contact:info> will result in a code 1000 with a <contact:infData> resData element.<response>


2303 Object does not existThe requested contact does not exist.

Contact.infData

The <contact:infData> element is send by the server in the to a successful command. It supplies the client<response> <contact:info>with the contact details of the contact requested in the command.<contact:info>

Scheme

15.14.13.12.11.10.

09.



<info><contact:info xmlns:contact="http://www.yoursrs.com/xml/epp/contact-1.0

"xsi:schemaLocation="http://www.yoursrs.com/xml/epp/contact-1.0


</contact:info></info><clTRID>client-12345</clTRID>

</command></epp>











id: The ID of the contact. The Repository Object Identifier, this is a server assigned unique ID.roid:

The status of the contact.status: The name of the contact.name:

The organization name of the contact.org: The street line(s) of the contact address with a minimum of one and a maximum of three lines.street:

The city of the contact address.city: The state or province of the contact address.sp: The postal code of the contact address.pc: The country code of the contact address.cc:

The telephone number of the contact.voice: The fax number of the contact.fax:

The email address of the contact.email: The sponsoring dealer of the contact.clID:

The creation date and time of the contact.crData: The date and time of the last update of the contact.upDate:

The gender and language attributes have been deprecated in favor of registry specific registry contact properties. The elements have notbeen removed from the schema's to support backwards compatibility, they will be ignored when supplied in command and will not bereturned in responses.

Example <response> with a <contact:infData> element with all elements



Example <response> with a <contact:infData> element with only required elements

42.41.40.39.38.37.36.35.34.33.32.31.30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<contact:infData xmlns:contact=""http://www.yoursrs.com/xml/epp/contact-1.0


<contact:id>contact-2</contact:id><contact:roid>12345-YOURSRS</contact:roid><contact:status s="ok"/><contact:postalInfo type="int">

<contact:name>John Doe</contact:name><contact:org>12Register B.V.</contact:org><contact:addr>

<contact:street>Schrevenweg 5</contact:street><contact:street>Street line 2</contact:street><contact:street>Street line 3</contact:street><contact:city>Zwolle</contact:city><contact:sp>Overijssel</contact:sp><contact:pc>8024 HB</contact:pc><contact:cc>NL</contact:cc>

</contact:addr></contact:postalInfo><contact:voice>+31.384530752</contact:voice><contact:fax>+31.384524734</contact:fax><contact:email>[email protected]</contact:email><contact:clID>dealer</contact:clID><contact:crDate>2005-02-14T09:59:14.0Z</contact:crDate><contact:upDate>2005-02-14T09:59:50.0Z</contact:upDate>

</contact:infData></resData><trID>


</trID></response>

</epp>









36.35.34.33.32.31.30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<contact:infData xmlns:contact=""http://www.yoursrs.com/xml/epp/contact-1.0


<contact:id>contact-2</contact:id><contact:roid>12345-YOURSRS</contact:roid><contact:status s="ok"/><contact:postalInfo type="int">

<contact:name>John Doe</contact:name><contact:addr>

<contact:street>Schrevenweg 5</contact:street><contact:city>Zwolle</contact:city><contact:pc>8024 HB</contact:pc><contact:cc>NL</contact:cc>

</contact:addr></contact:postalInfo><contact:voice>+31.384530752</contact:voice><contact:email>[email protected]</contact:email><contact:clID>dealer</contact:clID><contact:crDate>2005-02-14T09:59:14.0Z</contact:crDate>

</contact:infData></resData><trID>


</trID></response>

</epp>









Contact.CreateThis command is used to create a new contact

Scheme



id: The ID of the contact, this id may not exist, you can use a* *command to check if the ID is available.<contact:check> The name of the contactname:

The organisation name of the contact if given, a contact will be an organization, if not given the contact will be a private personorg: The street line(s) of the contact address with a minimum of one and a maximum of three lines.street:

The city of the contact addresscity: The state or province of the contact addresssp: The postal code of the contact addresspc: The country code of the contact addresscc:

The telephone number of the contactvoice: The fax number of the contactfax:

The email address of the contactemail:


Example <contact:create> command with all elements.

Example <contact:create> command with only required elements.

31.30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.12.11.10.

09.



<create><contact:create xmlns:contact="


contact-1.0.xsd"><contact:id>contact-4</contact:id><contact:postalInfo type="int">

<contact:name>John Doo</contact:name><contact:org>12Register B.V.</contact:org><contact:addr>

<contact:street>Schrevenweg 5</contact:street><contact:street>Extra address line 1</contact:street><contact:street>Extra addesss line 2</contact:street><contact:city>Zwolle</contact:city><contact:sp>Overijssel</contact:sp><contact:pc>8024 HB</contact:pc><contact:cc>NL</contact:cc>

</contact:addr></contact:postalInfo><contact:voice>+31.384530752</contact:voice><contact:fax>+31.384524734</contact:fax><contact:email>[email protected]</contact:email>

</contact:create></create><clTRID>client-12345</clTRID>

</command></epp>









A successful <contact:create> will result in a code 1000 with a <contact:creData> resData element.<response>


2302 Object existsThe given contact ID already exists.

Contact.creData

The <contact:creData> element is send by the server in the to a successful command. It supplies the client<response> <contact:create>with the contact creation details of the contact created in the command.<contact:create>

Scheme

id: The ID of the contact. The date and time the contact was created.crDate:

Example <response> with a <contact:creData> element

26.25.24.23.22.21.20.19.18.17.16.15.14.13.12.11.10.

09.



<create><contact:create xmlns:contact="


contact-1.0.xsd"><contact:id>contact-4</contact:id><contact:postalInfo type="int">

<contact:name>John Doo</contact:name><contact:addr>

<contact:street>Schrevenweg 5</contact:street><contact:city>Zwolle</contact:city><contact:pc>8024 HB</contact:pc><contact:cc>NL</contact:cc>

</contact:addr></contact:postalInfo><contact:voice>+31.384530752</contact:voice><contact:email>[email protected]</contact:email>

</contact:create></create><clTRID>client-12345</clTRID>

</command></epp>









22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<contact:creData xmlns:contact=""http://www.yoursrs.com/xml/epp/contact-1.0


<contact:id>contact-4</contact:id><contact:crDate>2005-12-27T09:38:53.0Z</contact:crDate>

</contact:creData></resData><trID>


</trID></response>

</epp>









Contact.UpdateThe <contact:update> command is used to change the details of a contact. The contact details will be changed for all domains which areusing the contact information. Because all TLD's have different rules on what may and what may not be changed it is possible a<contact:update> can not be executed because of its association with one or more domain names. Only the fields that are changedneeds to be specified, except for the fields inside the "addr" element, if one field inside the "addr" element is changed, all fields inside the"addr" element needs to be specified. Elements that are optional on creation may be deleted by specifying an empty element. Only the"id"element can not be changed.

Scheme



id: The ID of the contact to be changed. The name of the contact.name:

The organization name of the contact, if given a contact will be a organization, if not given the contact will be a private person. Thisorg:field may be deleted by specifying an empty element.

The street line(s) of the contact address with a minimum of one and a maximum of three lines.street: The city of the contact address.city:

The state or province of the contact address. This field can be deleted by not specifying it, an empty element is not needed becausesp:the entire address is re-specified.

The postal code of the contact address.pc: The country code of the contact address.cc:

The telephone number of the contact.voice: The fax number of the contact. This field may be deleted by specifying an empty element.fax:

The email address of the contact.email:


Example <contact:update> command where all fields are changed.



Example <contact:update> command where org, and fax are deleted

A successful <login> will result in a code 1000 or 1001 with no resData.<response>


2303 Object does not existThe requested contact does not exist

2305 Object association prohibits operationA TLD cannot execute the update due to TLD requirements. The specific reason and TLD is mentioned in the additional error messages.

31.30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.12.11.10.

09.



<update><contact:update xmlns:contact="


contact-1.0.xsd"><contact:id>contact-2</contact:id><contact:chg>

<contact:postalInfo type="int"><contact:name>John Doe</contact:name><contact:org>12Register B.V.</contact:org><contact:addr>

<contact:street>Schrevenweg 5</contact:street><contact:city>Zwolle</contact:city><contact:sp>Overijssel</contact:sp><contact:pc>8024 HB</contact:pc><contact:cc>NL</contact:cc>

</contact:addr></contact:postalInfo><contact:voice>+31.384530752</contact:voice><contact:fax>+31.384530752</contact:fax><contact:email>[email protected]</contact:email>

</contact:chg></contact:update>

</update><clTRID>client-12345</clTRID>

</command></epp>

22.21.20.19.18.17.16.15.14.13.12.11.10.

09.



<update><contact:update xmlns:contact="


contact-1.0.xsd"><contact:id>contact-2</contact:id><contact:chg>

<contact:postalInfo type="int"><contact:org/>

</contact:postalInfo><contact:voice>+31.384530752</contact:voice><contact:fax/>

</contact:chg></contact:update>


</command></epp>















Contact.DeleteProvided the contact is not in use, the <contact:delete> command can be used to remove a contact from the account.

Scheme

id: The ID of the contact to delete.

Example <contact:delete> command

A successful <contact:delete> will result in a code 1000 or 1001 with no resData.<response>


2303 Object does not existThe requested contact does not exist.

2305 Object association prohibits operationThe contact is being used in the system.

15.14.13.12.11.10.

09.



<delete><contact:delete xmlns:contact="



</contact:delete></delete><clTRID>client-12345</clTRID>

</command></epp>









5. DomainThe domain name space is used to manage the domain names in the system. If the name space is used in a command it needs to bedefined within the document, this can be done in the root <epp> element or in the first element of the domain name space.

Example name space definition in root element

Example name space definition in first domain name space element

15.14.13.12.11.10.09.08.07.

06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp xmlns=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:epp=" "http://www.yoursrs.com/xml/epp/epp-1.0xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0xmlns:xsi=" "http://www.w3.org/2001/XMLSchema-instancexsi:schemaLocation=" epp-1.0.xsd http://www.yoursrs.com/xml/epp/epp-1.0

domain-1.0.xsd"http://www.yoursrs.com/xml/epp/domain-1.0 ><command>

<check><domain:check>

</domain:check>


</command></epp>

15.14.13.12.11.10.



<check><domain:check xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0

xsi:schemaLocation="http://www.yoursrs.com/xml/epp/domain-1.0domain-1.0.xsd">

</domain:check>


</command></epp>















Domain.CheckThis command checks if a domain name is available for registration. A <domain:check> command can be used to check multiple domainnames at once. If more then one domain name needs to be checked it is faster to send one <domain:check> command with multipledomain names then to send multiple <domain:check> commands. It is faster to send a single <domain:check> command with multipledomain names instead of using multiple <domain:check> commands. An unlimited number of domain names can be checked in a singledomain check. However the response time will increase proportionally.

The <domain:check> command is mainly intended for usage in back office systems to check for availability before registration. For fontoffice systems like a shop the IsProxy is a far more simple and efficient method of availability checking.

Scheme

name: The domain name to be checked, including the TLD.

Example <domain:check> command with one domain name

Example <domain:check> command with three domain names

A successful <domain:check> will result in a code 1000 with a <domain:chkData> resData element.<response>

Domain.chkData

The <domain:chkData> element is send by the server in the to a successful command. It supplies the client<response> <domain:check>with the availability information of the domain name(s) in the command.<domain:check>

15.14.13.12.11.10.





<domain:name>domain.nl</domain:name></domain:check>


</command></epp>

17.16.15.14.13.12.11.10.





<domain:name>domain.nl</domain:name><domain:name>domain.be</domain:name><domain:name>domain.co.uk</domain:name>

</domain:check></check><clTRID>client-12345</clTRID>

</command></epp>















Scheme

For each checked domain name a <domain:cd> element is supplied.

*name: *The name of the checked domain name with an attribute "avail" and with value "1" for available or "0" for not available. If the domain name is not available for any other reason besides it already exists, this element contains the reason it is notreason:

available.

Example <response> with a <domain:chkData> element for one domain name

Example <response> with a <domain:chkData> element for three domain names

23.22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<domain:chkData xmlns:domain="http://www.yoursrs.com/xml/epp/domain-1.0"


<domain:cd><domain:name avail="1">domain.nl</domain:name>

</domain:cd></domain:chkData>

</resData><trID>


</trID></response>

</epp>









30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<domain:chkData xmlns:domain="http://www.yoursrs.com/xml/epp/domain-1.0"


<domain:cd><domain:name avail="1">domain.nl</domain:name>

</domain:cd><domain:cd>

<domain:name avail="0">domain.be</domain:name></domain:cd><domain:cd>

<domain:name avail="0">domain.abc</domain:name><domain:reason>TLD not supported</domain:reason>

</domain:cd></domain:chkData>

</resData><trID>


</trID></response>

</epp>









Domain.InfoThis command is used to retrieve details of an existing domain name.

Scheme

name: The domain name to request info of.

Example <domain:info> command

A successful <domain:info> will result in a code 1000 with a <domain:infData> resData element.<response>


2201 Authorization errorThe requested domain name does exist in the system but you are not authorized to request its details.

2303 Object does not existThe requested domain name does not exist in the system.

Domain.infData

The <domain:infData> element is send by the server in the to a successful command. It supplies the client<response> <domain:info>with the domain name details of the domain name requested in the command.<domain:info>

Scheme

15.14.13.12.11.10.



<info><domain:info xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0


<domain:name>domain.be</domain:name></domain:info>

</info><clTRID>client-12345</clTRID>

</command></epp>











name: The domain name. The Repository Object Identifier, this is a server assigned unique ID.roid:

The status of the domain name.status:ns:

hostAttr: The name servers associated with the domain name.template: Indicates a DNS zone exists for the domain and is not linked to the template.records: Indicates a DNS zone exists for the domain but is not linked to a template.

hostName: The host name of the name server. The IP address of the name server.hostAddr: The registrant contact of the domain name.registrant:

The other contacts associated with the domain name, the relation is specified in the type attribute.contact: The domain name has an auto renew setting. "y" for auto renew, "n" for no auto renew.renew:

The domain name is locked.lock: The sponsoring customer of the domain name.clID:

The creation date and time of the domain name.crDate: The date and time of the last update of the domain name,upDate: The expiration date and time of the domain name,exDate:

The auth password of the domain name.pw:

Example <response> with a <domain:infData> element with all elements



Example <response> with a <domain:infData> element with only required elements

45.44.43.42.41.40.39.38.37.36.35.34.33.32.31.30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<domain:infData xmlns:domain="http://www.yoursrs.com/xml/epp/domain-1.0"


<domain:name>domain.be</domain:name><domain:roid>12345-YOURSRS</domain:roid><domain:status s="ok"/><domain:ns>

<domain:hostAttr><domain:hostName>ns1.yoursrs.com</domain:hostName><domain:hostAddr>217.170.2.195</domain:hostAddr>

</domain:hostAttr><domain:hostAttr>

<domain:hostName>ns2.yoursrs.com</domain:hostName></domain:hostAttr>

</domain:ns><domain:registrant>contact-2</domain:registrant><domain:contact type="admin">contact-3</domain:contact><domain:contact type="billing">contact-3</domain:contact><domain:contact type="tech">contact-3</domain:contact><domain:renew>y</domain:renew><domain:lock/><domain:clID>customer</domain:clID><domain:crDate>2005-02-14T09:59:14.0Z</domain:crDate><domain:upDate>2005-02-14T09:59:50.0Z</domain:upDate><domain:exDate>2007-02-14T09:59:14.0Z</domain:exDate><domain:authInfo>

<domain:pw>key</domain:pw></domain:authInfo>

</domain:infData></resData><trID>


</trID></response>

</epp>









30.29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<domain:infData xmlns:domain="http://www.yoursrs.com/xml/epp/domain-1.0"


<domain:name>domain.be</domain:name><domain:roid>12345-YOURSRS</domain:roid><domain:status s="ok"/><domain:registrant>contact-2</domain:registrant><domain:contact type="admin">contact-3</domain:contact><domain:contact type="billing">contact-3</domain:contact><domain:contact type="tech">contact-3</domain:contact><domain:clID>customer</domain:clID><domain:crDate>2005-02-14T09:59:14.0Z</domain:crDate><domain:exDate>2007-02-14T09:59:14.0Z</domain:exDate>

</domain:infData></resData><trID>


</trID></response>

</epp>









Domain.CreateThis command is used to request a new domain name.

Scheme

name: The domain name to request.ns:

hostAttr: The name servers to be associated with the domain name.template: The template to use to create a DNS zone for the domain name.

hostName: The host name of the name server. The IP address of the name server.hostAddr: The registrant contact of the domain name.registrant:

The other contacts associated with the domain name, the relation is specified in the type attribute.contact: The domain name has an auto renew setting. "y" for auto renew, "n" for no auto renew.renew:

Example <domain:create> command with all elements.



Example <domain:create> command with only required elements.

A successful <domain:create> will result in a code 1000 or 1001 with a <domain:creData> resData element.<response>


2001 Command syntax error, Contact type "..." is restricted to occur only once*A contact type has been specified twice, there can only be 1 contact per contact type.2003 Required parameter is missing, Contact types admin, tech and billing are required*A contact must be specified for each of the contact types "admin", "billing" and "tech", one or more of these types have not beenspecified2003 Required parameter missing, If a name server host is equal to the domain name or if it's a subordinate host of the domainan ip address must be provided.*An IP address is required for the name server because the domain of which the name server is a part of is not yet created,therefore the name server host cannot be resolved to an IP address.2302 Object exists*The domain name is not available for registration.2303 Object does not exist, Contact "..." does not exist*The contact does not exist in the system, this can be the registrant or one of the other contacts.2306 Parameter value policy error, A domain may not have duplicate name server hosts*A name server host is given more than once in the same registration.

29.28.27.26.25.24.23.22.21.20.19.18.17.16.15.14.13.12.11.10.



<create><domain:create xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0


<domain:name>domain.nl</domain:name><domain:ns>

<domain:hostAttr><domain:hostName>ns1.yoursrs.com</domain:hostName><domain:hostAddr>217.170.2.195</domain:hostAddr>


<domain:hostName>ns2.yoursrs.com</domain:hostName></domain:hostAttr>

</domain:ns><domain:registrant>contact-2</domain:registrant><domain:contact type="admin">contact-3</domain:contact><domain:contact type="billing">contact-3</domain:contact><domain:contact type="tech">contact-3</domain:contact><domain:renew>n</domain:renew>

</domain:create></create><clTRID>client-12345</clTRID>

</command></epp>

19.18.17.16.15.14.13.12.11.10.



<create><domain:create xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0


<domain:name>domain.nl</domain:name><domain:registrant>contact-2</domain:registrant><domain:contact type="admin">contact-3</domain:contact><domain:contact type="billing">contact-3</domain:contact><domain:contact type="tech">contact-3</domain:contact>

</domain:create></create><clTRID>client-12345</clTRID>

</command></epp>















Other TLD specific errors may occur, additional error messages will be supplied with information about the error.

Domain.creData

The <domain:creData> element is send by the server in the to a successful command. It supplies the client<response> <domain:create>with the domain name creation details of the domain name created in the command.<domain:create>

Scheme

name: The requested domain name. The date and time the domain name was requested.crDate: The expiration date of the domain name.exDate:

Example <response> with a <domain:creData> element

23.22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<domain:creData xmlns:domain="http://www.yoursrs.com/xml/epp/domain-1.0"


<domain:name>domain.nl</domain:name><domain:crDate>2005-12-27T09:38:53.0Z</domain:crDate><domain:exDate>2006-12-27T09:38:53.0Z</domain:exDate>

</domain:creData></resData><trID>


</trID></response>

</epp>









Domain.UpdateThe <domain:update> command is used to change the details of a domain name. The registrant can not be changed with this command,this should be done with the command. Contact details can not be changed with this command, this should be done with<domain:trade>the command.<contact:update>

Scheme

name: The domain name. All things that are to be added into the domain name are specified in this element.add:

ns: The name servers that must be added to the domain name.lock: Lock the domain name.

rem: All things that are to be removed from the domain name are specified in this element.

ns: The name servers that must be removed to the domain name. There is no need to specify the '''hostAddr''', it will be ignored.



hostName: The host name of the name server.lock: Remove the lock from the domain name.

chg: All things that are to be changed are specified in this element.

contact: The contact(s) that must be changed.renew: The renew setting for the domain name. "y" for auto renew, "n" for no auto renew and undefined for default.template: The template to use to create a DNS zone for the domain name.

Example <domain:update>, add and remove a name server.

Example <domain:update>, lock a domain.

Example <domain:update>, unlock a domain, change a contact and renew setting.

30.29.28.27.26.25.24.23.

22.21.20.19.18.17.16.

15.

14.13.12.11.10.



<update><domain:update xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0


<domain:name>domain.be</domain:name><domain:add>

<domain:ns><domain:hostAttr>

<domain:hostName>ns3.yoursrs.com</domain:hostName>

<domain:hostAddr>217.170.2.191</domain:hostAddr>

</domain:hostAttr></domain:ns>

</domain:add><domain:rem>



</domain:hostAttr></domain:ns>

</domain:rem></domain:update>


</command></epp>

18.17.16.15.14.13.12.11.10.





<domain:name>domain.be</domain:name><domain:add>

<domain:lock/></domain:add>

</domain:update></update><clTRID>client-12345</clTRID>

</command></epp>















Example <domain:update>, remove renew setting.

A successful <domain:update> will result in a code 1000 or 1001 with no resData.<response>


2003 Required parameter missing, If a name server host is equal to the domain name or if it's a subordinate host of the domainan ip address must be provided.*An IP address is required for the name server because the domain of which the name server is a part of is not created yet,therefore the name server host cannot be resolved to an IP address.2201 Authorization error*The requested domain name does exist in the system but you are not authorized to change it.2303 Object does not exist*The domain name does not exist in the system.2303 Object does not exist, Contact "..." does not exist*A chg contact was requested but the contact does not exist in the system.2304 Object status prohibits operation, "..." is already locked*An add lock was requested but the domain name is already locked.2304 Object status prohibits operation, "..." is not locked*A rem lock was requested but the domain name is not locked.2306 Parameter value policy error, "..." cannot be locked*An add lock was requested but the TLD does not allow a lock.2306 Parameter value policy error, "..." cannot be unlocked*A rem lock was requested but the TLD does not allow a lock to be removed.2306 Parameter value policy error, Contact "..." already is the ... contact for "..."*A chg contact was requested but the specified contact is already2306 Parameter value policy error, Name server "..." is already linked to "..."*An add ns was requested but the name server is already associated with the domain name and it can not be deleted using samecommand.

22.21.20.19.18.17.16.15.14.13.12.11.10.





<domain:name>domain.be</domain:name><domain:rem>

<domain:lock/></domain:rem><domain:chg>

<domain:contact type="admin">contact-5</domain:contact><domain:renew>y</domain:renew>

</domain:chg></domain:update>


</command></epp>

18.17.16.15.14.13.12.11.10.





<domain:name>domain.be</domain:name><domain:chg>

<domain:renew/></domain:chg>

</domain:update></update><clTRID>client-12345</clTRID>

</command></epp>















2306 Parameter value policy error, Name server "..." is not linked to "..."*A rem ns was requested but the name server is not associated with the domain name.2306 Parameter value policy error, A domain may not have duplicate name server hosts*A name server host is given more than once in the same registration.




Domain.RenewThe <domain:renew> command is used to extend the validity period of a domain name.

Scheme

name: The domain name. The current expiration date of the domain name. This value ensures that repeated <renew> commands do not result incurExpDate:

multiple unanticipated successful renewals.

*Exampele <domain:renew> command.*will be supplied with information about the error.

A successful <domain:renew> will result in a code 1000 or 1001 with a <domain:renData> resData element.<response>


2201 Authorization errorThe requested domain name does exist in the system but you are not authorized to request its details.

2303 Object does not existThe requested domain name does not exist in the system.

2306 Parameter value policy error, curExpDate for "..." is invalidThe given curExpDate does not match the current expiration date.

Other TLD specific errors may occur, additional error messages will be supplied with information on the error.

Domain.renData

The <domain:renData> element is send by the server in the to a successful command. It supplies the client<response> <domain:renew>with the domain name renewal details of the command.<domain:renew>

Scheme

16.15.14.13.12.11.10.



<renew><domain:renew xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0


<domain:name>domain.be</domain:name><domain:curExpDate>2007-02-14</domain:curExpDate>

</domain:renew></renew><clTRID>client-12345</clTRID>

</command></epp>









name:The renewed domain name.exDate:The new expiration date of the domain name.

Example <response> with a <domain:renData> element

22.21.20.19.18.17.16.15.14.13.

12.




</result><resData>

<domain:renData xmlns:domain="http://www.yoursrs.com/xml/epp/domain-1.0"


<domain:name>domain.be</domain:name><domain:exDate>2008-02-14T09:59:14.0Z</domain:exDate>

</domain:renData></resData><trID>


</trID></response>

</epp>









Domain.TransferThe <domain:transfer> command is used to transfer a domain from another registrar to your account.

Scheme

name: The domain name The type of transfer requested, there are 2 options:type:

"transfer": The domain is transferred, the owner of the domain name may not be changed."trade": The domain is transferred and traded, the owner of the domain name changes.

name: The domain name to request.ns:

hostAttr: The name servers to be associated with the domain name.template: The template to use to create a DNS zone for the domain name.

hostName: The host name of the name server. The IP address of the name server.hostAddr:



The registrant contact of the domain name.registrant: The other contacts associated with the domain name, the relation is specified in the type attribute.contact:

The auth password of the domain name.pw:

The <domain:transfer> command has five operations that will be explained hereafter.

Domain.Transfer.Request

The "request" operation is used to start a transfer. The <domain:request> element is required for this operation.

Example <domain:transfer> with the "request" operation:

A successful <domain:transfer> will result in a code 1000 or 1001 with a <domain:trnData> resData element.<response>


2001 Command syntax error, Contact type "..." is restricted to occur only once*A contact type has been specified twice, there can only be 1 contact per contact type.2003 Required parameter is missing, Contact types admin, tech and billing are required*A contact must be specified for each of the contact types "admin", "billing" and "tech", one or more of these types have not beenspecified2003 Required parameter missing, If a name server host is equal to the domain name or if it's a subordinate host of the domainan ip address must be provided.*A IP address is required for the name server because the domain of which the name server is a part of not created yet, thereforethe name server host cannot be resolved to an IP address.2303 Object does not exist*The domain is available for registration thus it can not be transferred.2303 Object does not exist, Contact "..." does not exist*The contact does not exist in the system, this can be the registrant or one of the other contacts.2304 Object status prohibits operation*The status of the domain name does not allow a transfer.2306 Parameter value policy error, A domain may not have duplicate name server hosts*A name server host is given more then once in the same registration.*


34.33.32.31.30.29.28.27.26.25.24.23.22.21.20.19.

18.17.16.

15.

14.13.12.11.10.

09.

08.07.06.05.04.03.02.01. <?xml version="1.0" encoding="UTF-8" standalone="no" ?>


<transfer op="request"><domain:transfer xmlns:domain="

"http://www.yoursrs.com/xml/epp/domain-1.0xsi:schemaLocation="http://www.yoursrs.com/xml/epp/domain-1.0

domain-1.0.xsd"><domain:name>transfer.be</domain:name><domain:request type="transfer">



<domain:hostAddr>217.170.2.195</domain:hostAddr>



<domain:hostAddr>62.58.71.202</domain:hostAddr></domain:hostAttr>

</domain:ns><domain:registrant>contact-2</domain:registrant><domain:contact type="admin">contact-3</domain:contact><domain:contact type="billing">contact-3</domain:contact><domain:contact type="tech">contact-3</domain:contact>

</domain:request><domain:authInfo>

<domain:pw>code</domain:pw></domain:authInfo>

</domain:transfer></transfer><clTRID>client-12345</clTRID>

</command></epp>









Domain.Transfer.Query

The "query" operation is used to request info of an active transfer.

Example <domain:transfer> with the "query" operation:

A successful <domain:transfer> will result in a code 1000 or 1001 with a <domain:trnData> resData element.<response>


2301 Object not pending transferThere is no active transfer for this domain.

Domain.Transfer.Cancel

The "cancel" operation is used to cancel a transfer. This is only possible if the transfer is in FOA stage.

Example <domain:transfer> with the "cancel" operation:

A successful <domain:transfer> will result in a code 1000 or 1001 with no resData element.<response>


2301 Object not pending transferThere is no active transfer for this domain.

2304 Object status prohibits operationThe status of the transfer does not allow a "cancel" operation.

Domain.Transfer.Approve

The "approve" operation is used to approve a transfer that is in FOA stage, this operation is executed by the registrant of the domainname. If a registrant forwards the auth code with the request to approve the transfer, this command may be used to approve the transfer.

Example <domain:transfer> with the "approve" operation:

15.14.13.12.11.10.

09.



<transfer op="query"><domain:transfer xmlns:domain="


domain-1.0.xsd"><domain:name>transfer.be</domain:name>


</command></epp>

15.14.13.12.11.10.

09.



<transfer op="cancel"><domain:transfer xmlns:domain="


domain-1.0.xsd"><domain:name>transfer.be</domain:name>


</command></epp>

















2002 Command use error, This transfer code has been used on <date>*The auth code has been used so can not be used again.

2002 Command use error, The approve had already been sent before <date>*The auth code is not valid anymore.

2202 Invalid authorization information*The auth code is incorrect.

2301 Object not pending transfer*There is no active transfer for this domain.

2304 Object status prohibits operation*The status of the transfer does not allow an "approve" operation.

Domain.Transfer.Reject

The "reject" operation is used to reject a transfer that is in FOA stage, this operation is executed by the registrant of the domain name. Ifa registrant forwards the auth code with the request to reject the transfer this command may be used to reject the transfer.

Example <domain:transfer> with the "reject" operation:



2002 Command use error, This transfer code has been used on <date>*

18.17.16.15.14.13.12.11.10.

09.



<transfer op="approve"><domain:transfer xmlns:domain="


domain-1.0.xsd"><domain:name>transfer.be</domain:name><domain:authInfo>



</command></epp>

18.17.16.15.14.13.12.11.10.

09.



<transfer op="reject"><domain:transfer xmlns:domain="


domain-1.0.xsd"><domain:name>transfer.be</domain:name><domain:authInfo>



</command></epp>















The auth code has been used so can not be used again.2002 Command use error, The reject had to be send before <date>*The auth code is not valid anymore2202 Invalid authorization information*The auth code is incorrect2301 Object not pending transfer*There is no active transfer for this domain.2304 Object status prohibits operation*The status of the transfer does not allow a "reject" operation.

Domain.trnData

Scheme




</result><trID>


</trID></response>

</epp>







Domain.TradeThis command is used to change the registrant of a domain name.

Scheme

name: The domain name to trade. The new registrant for the domain name.registrant:

This field is solely used for TLD's where the registry requires a authorization code to execute the trade and the Registry supplies thepw:auth code directly to the registrant. When the auth code is required but not supplied, Realtime Register will attempt to request the authcode. The auth code will be send by the registry to the registrant. After you have retrieved the auth code from the registrant the trade canbe requested with use of the auth code.

Exampele <domain:trade> command.

A successful <domain:trade> will result in a code 1000 or 1001 with no resData element.<response>

The following errors may occur:2201 Authorization errorThe requested domain name does exist in the system but you are not authorized to request its details.

2303 Object does not existThe domain name does not exist in the system

2303 Object does not exist, Contact "..." does not existThe new registrant contact does not exist in the system.


16.15.14.13.12.11.10.



<trade><domain:trade xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0


<domain:name>transfer.be</domain:name><domain:registrant>contact-2</domain:registrant>

</domain:trade></trade><clTRID>client-12345</clTRID>

</command></epp>









Domain.DeleteThe <domain:delete> command is used to delete a domain name.

Scheme

name: The domain name to delete.

Exampele <domain:delete> command.

A successful <domain:trade> will result in a code 1000 or 1001 with no resData element.<response>

The following errors may occur:2201 Authorization errorThe requested domain name does exist in the system but you are not authorized to request its details.

2303 Object does not existThe domain name does not exist in the system


15.14.13.12.11.10.



<delete><domain:delete xmlns:domain=" "http://www.yoursrs.com/xml/epp/domain-1.0


<domain:name>domain.be</domain:name></domain:delete>

</delete><clTRID>client-12345</clTRID>

</command></epp>

Documents

EPP API Documentation - Realtime Register! · PDF fileEPP API Documentation, V2.0, Juli 2013 ... 00000030 6F 6E 65 3D 22 6E 6F 22 - 20 3F 3E 3C 65 70 70 20 one="no" ?>