Difference between revisions of "Transfer"
From Boxis.net API Docs
| Line 8: | Line 8: | ||
| - '''domain'''::String::Domain name that you need to Transfer. | | - '''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 | + | | - '''auth-code'''::String::Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer. |
| − | transfer. | + | |
|- | |- | ||
| − | | - '''ns'''::Array of Strings::List of Name Servers to be associated with the domain name. A maximum of 5 | + | | - '''ns'''::Array of Strings::List of Name Servers to be associated with the domain name. A maximum of 5 Name Servers can be specified. |
| − | Name Servers can be specified. | + | |
|- | |- | ||
| - '''protect-privacy'''::Boolean::Enables / Disables the Privacy Protection setting for the domain name. | | - '''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 | + | | - '''protection-lock'''::Boolean::Enable / Disable Protection Lock service. Possible values are: true or false. |
| − | false. | + | |
|- | |- | ||
| - '''auto-renewal'''::Boolean::Enable / Disable Auto-Renewal service. Possible values are: true or false. | | - '''auto-renewal'''::Boolean::Enable / Disable Auto-Renewal service. Possible values are: true or false. | ||
| Line 57: | Line 54: | ||
==== Errors Descriptions ==== | ==== Errors Descriptions ==== | ||
| + | {| | ||
|- | |- | ||
| - 'domain' is not valid | | - 'domain' is not valid | ||
Revision as of 13:21, 2 May 2012
Contents
Domain Function: Transfer
With this command, you are able to transfer your domain to boxis.net..... bla bla bla here
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 |
