Difference between revisions of "Transfer"

From Boxis.net API Docs
Jump to: navigation, search
Line 23: Line 23:
 
==== example in XML ====
 
==== example in XML ====
  
===== Success =====
+
===== success =====
  
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 33: Line 33:
 
</return>
 
</return>
  
===== Error =====
+
===== error =====
  
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 45: Line 45:
 
==== Example in Json  ====
 
==== Example in Json  ====
  
===== Success =====
+
===== success =====
  
{"result":"1","resulttxt":"success","params":[],"timestamp":1335777400}
+
{"result":"1",
 +
"resulttxt":"success",
 +
"params":[],
 +
"timestamp":1335777400}
  
===== Error =====
+
===== error =====
 
+
{"result":"0","resulttxt":"Error: {error description}","params":[],"timestamp":1335777400}
+
  
 +
{"result":"0",
 +
"resulttxt":"Error: {error description}",
 +
"params":[],
 +
"timestamp":1335777400}
 
==== Errors Descriptions ====
 
==== Errors Descriptions ====
 
{|
 
{|

Revision as of 12:53, 2 May 2012

Domain Function: Transfer

With this command, you are able to transfer your domain to boxis.net.

Input params

- domain::String::Domain name that you need to Transfer.
- auth-code::String::Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer.
- ns::Array of Strings::List of Name Servers to be associated with the domain name. A maximum of 5 Name Servers can be specified.
- protect-privacy::Boolean::Enables / Disables the Privacy Protection setting for the domain name.
- protection-lock::Boolean::Enable / Disable Protection Lock service. Possible values are: true or false.
- auto-renewal::Boolean::Enable / Disable Auto-Renewal service. Possible values are: true or false.

Output params

example in XML

success

<?xml version="1.0" encoding="UTF-8"?> <return>

 <result>1</result>
 <resulttxt>success</resulttxt>
 <params/>
 <timestamp>1335767184</timestamp>

</return>

error

<?xml version="1.0" encoding="UTF-8"?> <return>

 <result>0</result>
 <resulttxt>Error: {error description}</resulttxt>
 <params/>
 <timestamp>1335767184</timestamp>

</return>

Example in Json

success

{"result":"1",

"resulttxt":"success",
"params":[],
"timestamp":1335777400}
error

{"result":"0",

"resulttxt":"Error: {error description}",
"params":[],
"timestamp":1335777400}

Errors Descriptions

- 'domain' is not valid
- there is no such tld
- 'years' value is not valid
- 'ns' could not be greater than five
- 'protect-privacy' value is not valid
- 'protection-lock' value is not valid
- 'autorenew' value is not valid
- domain 'testdomain.com' is not available
- domain not transfered