Difference between revisions of "Register"
From Boxis.net API Docs
(→Errors Descriptions) |
|||
| Line 4: | Line 4: | ||
=Domain Function: Register= | =Domain Function: Register= | ||
| − | With this command, you are able to register your domain with boxis.net. | + | With this command, you are able to register your domain with boxis.net. |
=== Input params === | === Input params === | ||
| Line 16: | Line 16: | ||
|- | |- | ||
| - '''protect-privacy'''::Boolean::Enables / Disables the Privacy Protection setting for the domain name. Possible values are: 1 or 0 | | - '''protect-privacy'''::Boolean::Enables / Disables the Privacy Protection setting for the domain name. Possible values are: 1 or 0 | ||
| + | |} | ||
=== Output params === | === Output params === | ||
| Line 52: | Line 53: | ||
==== Errors Descriptions ==== | ==== Errors Descriptions ==== | ||
| + | {| | ||
|- | |- | ||
| - 'domain' is not valid | | - 'domain' is not valid | ||
Revision as of 13:24, 2 May 2012
Contents
Domain Function: Register
With this command, you are able to register your domain with boxis.net.
Input params
| - domain::String::Domain name that you need to Register |
| - years::Integer::Number of years for which you wish to Register this domain name |
| - 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. Possible values are: 1 or 0 |
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 |
| - domain 'testdomain.com' is not available |
| - domain not created |
