Personal tools

From HEXONET Wiki

Jump to: navigation, search
Line 4: Line 4:
 
__TOC__
 
__TOC__
  
= API Commands =
+
= API =
 
+
'''TRADEDOMAIN'''
+
  
 +
=== TRADEDOMAIN ===
 
[COMMAND]
 
[COMMAND]
 
<pre>
 
<pre>
 
COMMAND = TradeDomain
 
COMMAND = TradeDomain
<span class="label label-important">REQUIRED</span>
 
 
DOMAIN = <DOMAIN>
 
DOMAIN = <DOMAIN>
 +
</pre>
 +
<span class="label label-important">REQUIRED</span>
 +
<pre>
 
OWNERCONTACT0 = <CONTACT>
 
OWNERCONTACT0 = <CONTACT>
 
X-CONFIRM-DA-NEW-REGISTRANT = 1
 
X-CONFIRM-DA-NEW-REGISTRANT = 1
 +
</pre>
 
<span class="label label-info">OPTIONAL</span>
 
<span class="label label-info">OPTIONAL</span>
 +
<pre>
 
X-CONFIRM-DA-OLD-REGISTRANT = 1
 
X-CONFIRM-DA-OLD-REGISTRANT = 1
EOF
 
 
</pre>
 
</pre>
 
<br>
 
<br>
Line 24: Line 26:
 
DESCRIPTION = Command completed successfully; realtime domain trade succeeded
 
DESCRIPTION = Command completed successfully; realtime domain trade succeeded
 
CODE = 200
 
CODE = 200
EOF
 
 
</pre>
 
</pre>
 +
<br>
  
 
+
=== STATUSDOMAIN ===
'''STATUSDOMAIN'''
+
 
+
 
[COMMAND]
 
[COMMAND]
 
<pre>
 
<pre>
 
COMMAND = StatusDomain
 
COMMAND = StatusDomain
DOMAIN = btc.info
+
DOMAIN = <DOMAIN>
EOF
+
 
</pre>
 
</pre>
 
+
<br>
 
[RESPONSE]
 
[RESPONSE]
 
<pre>
 
<pre>
Line 52: Line 51:
 
PROPERTY[TRADE-TRANSFERLOCK-EXPIRATIONDATE][0] = YYYY-MM-DD HH:MM:SS
 
PROPERTY[TRADE-TRANSFERLOCK-EXPIRATIONDATE][0] = YYYY-MM-DD HH:MM:SS
 
...
 
...
EOF
 
 
</pre>
 
</pre>
 +
<br>
  
 
+
=== MODIFYDOMAIN ===
 
+
[HEADER]
+
USER=test.user
+
 
+
 
[COMMAND]
 
[COMMAND]
 +
<pre>
 
COMMAND = ModifyDomain
 
COMMAND = ModifyDomain
DOMAIN = btc.info
+
DOMAIN = <DOMAIN>
 +
...
 +
</pre>
 +
<span class="label label-important">OPTIONAL</span>
 +
<pre>
 
TRANSFERLOCK = 0
 
TRANSFERLOCK = 0
EOF
+
</pre>
 
+
<br>
 
[RESPONSE]
 
[RESPONSE]
CODE=552
+
<pre>
DESCRIPTION=Object status does not allow for operation; Change of Registrant TRANSFERLOCK in place until 2017-01-09 09:53:24
+
CODE =5 52
EOF
+
DESCRIPTION=Object status does not allow for operation; Change of Registrant TRANSFERLOCK in place until YYYY-MM-DD HH:MM:SS
 
+
</pre>
 
+
<br>
With opt-out from transferlock:
+
 
+
  
 +
=== TRADEDOMAIN with OPT-OUT from transferlock===
 
[COMMAND]
 
[COMMAND]
COMMAND=TradeDomain
+
<pre>
DOMAIN=btc.info
+
COMMAND = TradeDomain
OWNERCONTACT0=P-JUW40
+
DOMAIN = <DOMAIN>
X-CONFIRM-DA-NEW-REGISTRANT=1
+
</pre>
X-REQUEST-OPT-OUT-TRANSFERLOCK=1
+
<span class="label label-important">REQUIRED</span>
EOF
+
<pre>
 
+
OWNERCONTACT0 = P-ABC123
 
+
X-CONFIRM-DA-NEW-REGISTRANT = 1
 +
X-REQUEST-OPT-OUT-TRANSFERLOCK = 1
 +
</pre>
 +
<br>
 
[RESPONSE]
 
[RESPONSE]
DESCRIPTION=Command completed successfully; trade pending - non-real-time
+
<pre>
CODE=200
+
DESCRIPTION = Command completed successfully; trade pending - non-real-time
PENDING=1
+
CODE = 200
QUEUETIME=0
+
PENDING = 1
RUNTIME=0.96
+
</pre>
EOF
+

Revision as of 15:10, 11 November 2016

Domain API

Contents


API

TRADEDOMAIN

[COMMAND]

COMMAND = TradeDomain
DOMAIN = <DOMAIN>

REQUIRED

OWNERCONTACT0 = <CONTACT>
X-CONFIRM-DA-NEW-REGISTRANT = 1

OPTIONAL

X-CONFIRM-DA-OLD-REGISTRANT = 1


[RESPONSE]

DESCRIPTION = Command completed successfully; realtime domain trade succeeded
CODE = 200


STATUSDOMAIN

[COMMAND]

COMMAND = StatusDomain
DOMAIN = <DOMAIN>


[RESPONSE]

CODE = 200
DESCRIPTION = Command completed successfully
PROPERTY[STATUS][0] = ACTIVE
PROPERTY[STATUS][1] = clientTransferProhibited
...
PROPERTY[CURRENT-REGISTRANT-NAME][0] = ...
PROPERTY[CURRENT-REGISTRANT-ORGANIZATION][0] = ...
PROPERTY[CURRENT-REGISTRANT-EMAIL][0] = ...
...
PROPERTY[TRANSFERLOCK][0] = 1
PROPERTY[TRANSFERLOCK-EXPIRATIONDATE][0] = YYYY-MM-DD HH:MM:SS
PROPERTY[TRADE-TRANSFERLOCK-EXPIRATIONDATE][0] = YYYY-MM-DD HH:MM:SS
...


MODIFYDOMAIN

[COMMAND]

COMMAND = ModifyDomain
DOMAIN = <DOMAIN>
...

OPTIONAL

TRANSFERLOCK = 0


[RESPONSE]

CODE =5 52
DESCRIPTION=Object status does not allow for operation; Change of Registrant TRANSFERLOCK in place until YYYY-MM-DD HH:MM:SS


TRADEDOMAIN with OPT-OUT from transferlock

[COMMAND]

COMMAND = TradeDomain
DOMAIN = <DOMAIN>

REQUIRED

OWNERCONTACT0 = P-ABC123
X-CONFIRM-DA-NEW-REGISTRANT = 1
X-REQUEST-OPT-OUT-TRANSFERLOCK = 1


[RESPONSE]

DESCRIPTION = Command completed successfully; trade pending - non-real-time
CODE = 200
PENDING = 1