Editing NewTLD Main Page (section)

= APIs =

=== Create a new Sunrise Application ===

<span class="label label-important">REQUIRED</span>
<pre>
command = AddDomainApplication
class = (TLD)_SUNRISE
domain = (DOMAIN)
ownercontact0 = (CONTACT)
admincontact0 = (CONTACT)
techcontact0 = (CONTACT)
billingcontact0 = (CONTACT)
SMD0 = -----BEGIN ENCODED SMD-----
SMD1 = PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PHN
SMD2 = tZDpzaWduZWRNYXJrIHhtbG5zOnNtZD0idXJuOmlldGY6cGFyYW1zOnhtbDpuczpzaWduZWRNYX
SMD3 = JrLTEuMCIgaWQ9InNpZ25lZE1hcmsiPgogIDxzbWQ6aWQ+MS01NjY1Nzwvc21kOmlkPgogIDxzb
SMD4 = WQ6aXNzdWVySW5mbyBpc3N1ZXJJRD0iMyI+CiAgICA8c21kOm9yZz5NYXJrIFZhbGlkYXRvcjwv
SMD5 = c21kOm9yZz4KICAgIDxzbWQ6ZW1haWw+bWFya3ZhbGlkYXRvckBtYXJrdmFsaWRhdG9yLmNvbTw
SMD6 = vc21kOmVtYWlsPgogICAgPHNtZDp1cmw+aHR0cDovL3d3dy5tYXJrdmFsaWRhdG9yLmNvbTwvc2
SMD7 = 1kOnVybD4KICAgIDxzbWQ6dm9pY2UgeD0iMTIzNCI+KzQzLjg4ODg5OTk5PC9zbWQ6dm9pY2U+C
SMD8 = ...
</pre>

=== Create an Early Access Program Application ===

<span class="label label-important">REQUIRED</span>
<pre>
command = AddDomainApplication
class = <TLD>_EARLYACCESS1
domain = <DOMAIN>
ownercontact0 = <CONTACT>
admincontact0 = <CONTACT>
techcontact0 = <CONTACT>
billingcontact0 = <CONTACT>
</pre>
the same command can be used with these classes:

<span class="label label-info">OPTIONAL</span>
<pre>
<TLD>_EARLYACCESS2
<TLD>_EARLYACCESS3
<TLD>_EARLYACCESS4
<TLD>_EARLYACCESS5
</pre>

=== Create a GoLive Application ===

<span class="label label-important">REQUIRED</span>
<pre>
command = AddDomainApplication
class = <TLD>_GOLIVE
domain = <DOMAIN>
ownercontact0 = <CONTACT>
admincontact0 = <CONTACT>
techcontact0 = <CONTACT>
billingcontact0 = <CONTACT>
</pre>

=== Converting EOIs to Applications ===

In order to convert an EOI to a domain application by API you simply have to create your domain
application using the API commands above adding the following parameter:

<span class="label label-info">OPTIONAL</span>
<pre>
EOI = <YOUR-EOI-APPLICATION-ID>
</pre>
<div class="alerthexonet alerthexonet-error">
- You can only use your EOI once in order to create one domain application for a matching domain

- Also if you create several domain applications for the same domain but different launch phases it is only possible to convert one EOI to one application
</div>

Convert an EOI for example.bike to an Early Access Program Application for day 3:

<pre>
command = AddDomainApplication
class = BIKE_EARLYACCESS3
domain = example.bike
ownercontact0 = <CONTACT>
admincontact0 = <CONTACT>
techcontact0 = <CONTACT>
billingcontact0 = <CONTACT>
eoi = 12345
</pre>

=== Claim notice ===
'''CheckDomain - CheckDomain with phase "CLAIMS"'''

The following API command will return if there are claims for dedicated domains INSTEAD of returning the availability of the domain. There will be no indication if a domain name is available for registration. Only if there exist claims for a domain name or not:

<span class="label label-important">REQUIRED</span>
<pre>
[COMMAND]
command = CheckDomain
domain = testandvalidate.claimsga
phase = claims
EOF

[RESPONSE]
PROPERTY[REASON][0]=
PROPERTY[CLAIMKEY][0]=2016022400/9/C/C/nMOg6mHD1apH6FT2dGEilYPb0000000259
DESCRIPTION=Claim exists
CODE=211
EOF 
</pre>
<br>
'''Querying the NOTICE-POA-ACCEPT-HASH'''

The claimkey can be used to query trademark details with the StatusTMDBClaim command. Response parameters are:

* '''NOTICE-POA-ACCEPT-HASH'''
* NOTICE-CREATEDDATE
* NOTICE-XML 
* NOTICE-TEXT 
* NOTICE-ACCEPT-ID 
* NOTICE-EXPIRATIONDATE
<span class="label label-important">REQUIRED</span>
<pre>
[COMMAND]
command = StatusTMDBClaim
claimkey = 2016022400/9/C/C/nMOg6mHD1apH6FT2dGEilYPb0000000259
EOF

[RESPONSE]
CODE=200
DESCRIPTION=Command completed successfully
PROPERTY[NOTICE-POA-ACCEPT-HASH][0]=44bd79ddca75ec1ce480e5531100f110
PROPERTY[NOTICE-ACCEPT-ID][0]=284372db0000000000000782197
PROPERTY[NOTICE-CREATEDDATE][0]=2016-02-24 00:00:00
PROPERTY[NOTICE-EXPIRATIONDATE][0]=2016-02-26 00:00:00 
...
</pre>
<br>
'''AddDomain'''

In order to register a claims domain you have to provide the '''NOTICE-POA-ACCEPT-HASH''' parameter.
Claims ensures that all Registrants who want to register a domain name matching existing Clearinghouse record are presented with a Trademark Notice and
notifies trademark holders or agents of the registration of a domain name matching a label of a registered and validated mark name in the TMDB.
By submitting the NOTICE-POA-ACCEPT-HASH the registrant confirms that he is aware that the domain name matches a trademark registered in the Clearinghouse.<br> 
<span class="label label-important">REQUIRED</span>
<pre>
[COMMAND]
command = AddDomain
domain = testandvalidate.claimsga
NOTICE-POA-ACCEPT-HASH = 44bd79ddca75ec1ce480e5531100f110
...
EOF

[RESPONSE]
PROPERTY[STATUS][0]=ACTIVE
PROPERTY[REGISTRATIONEXPIRATIONDATE][0]=2017-02-24 11:08:15
DESCRIPTION=Command completed successfully
CODE=200
EOF

</pre>
<br>
'''AddDomainApplication'''

In order to pre-register a claims domain you have to provide the NOTICE-POA-ACCEPT-HASH parameter and the class.<br> 
<span class="label label-important">REQUIRED</span>
<pre>
[COMMAND]
COMMAND = AddDomainApplication
DOMAIN = testandvalidate.claimsga
CLASS = CLAIMSGA_GOLIVE
...
EOF
</pre>

=== Premium Domains ===
Below you will find an example '''"CheckDomains"''' command for a so called "Premium" domain:
<br>
<span class="label label-important">REQUIRED</span>
<pre>
[COMMAND]
command = CheckDomains
domain0 = <TEXT>
premiumchannels = *
EOF

[RESPONSE]
PROPERTY[PREMIUMCHANNEL][0]=DONUTS
PROPERTY[PRICE][0]=xx.xx
PROPERTY[REASON][0]=Premium Domain Name
PROPERTY[DOMAINCHECKTIME][0]=0.032
PROPERTY[CLASS][0]=PREMIUM_DONUTS_BBBB
PROPERTY[CURRENCY][0]=USD
PROPERTY[DOMAINCHECK][0]=211 Premium Domain name available [PREMIUM]
DESCRIPTION=Command completed successfully
CODE=200
QUEUETIME=0.001
RUNTIME=0.208
</pre>
<br>
The '''"CLASS"''' parameter have to be used at the AddDomain command:
<pre>
command = AddDomainApplication
class = PREMIUM_DONUTS_BBBB
...
</pre>
<br>
In order to '''query the renewal price''' of a dedicated domain of your portfolio you can
extend the StatusDomain command as follows. This is also possible for premium domains:
<br>
<span class="label label-important">REQUIRED</span>
<pre>
[COMMAND]
command = StatusDomain
domain = <DOMAIN>
properties = PRICE
EOF

[RESPONSE]
...
PROPERTY[CURRENCY][0]=EUR
PROPERTY[RENEWALPRICE][0]=10.00
PROPERTY[RENEWALGROSSPRICE][0]=11.90
PROPERTY[VAT][0]=19.00
...
EOF

</pre>
<br>