Difference between revisions of "Register"
From Boxis.net API Docs
| Line 24: | Line 24: | ||
===== success ===== | ===== success ===== | ||
| + | <pre> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<return> | <return> | ||
| Line 31: | Line 32: | ||
<timestamp>1335767184</timestamp> | <timestamp>1335767184</timestamp> | ||
</return> | </return> | ||
| + | </pre> | ||
===== error ===== | ===== error ===== | ||
| + | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| Line 46: | Line 49: | ||
===== success ===== | ===== success ===== | ||
| + | <pre> | ||
{"result":"1", | {"result":"1", | ||
"resulttxt":"success", | "resulttxt":"success", | ||
"params":[], | "params":[], | ||
"timestamp":1335777400} | "timestamp":1335777400} | ||
| + | </pre> | ||
===== error ===== | ===== error ===== | ||
| + | <pre> | ||
{"result":"0", | {"result":"0", | ||
"resulttxt":"Error: {error description}", | "resulttxt":"Error: {error description}", | ||
"params":[], | "params":[], | ||
"timestamp":1335777400} | "timestamp":1335777400} | ||
| + | </pre> | ||
==== Errors Descriptions ==== | ==== Errors Descriptions ==== | ||
Revision as of 07:57, 7 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 |
