Modifying the Privacy Protection Status: Difference between revisions

From Boxis.net API Docs
Jump to navigation Jump to search
No edit summary
No edit summary
Line 17: Line 17:
===== success =====
===== success =====


<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<return>
<return>
Line 24: Line 25:
   <timestamp>1335767184</timestamp>
   <timestamp>1335767184</timestamp>
</return>
</return>
</pre>


===== error =====
===== error =====


<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<return>
<return>
Line 34: Line 37:
   <timestamp>1335767184</timestamp>
   <timestamp>1335767184</timestamp>
</return>
</return>
</pre>


==== Example in Json  ====
==== Example in Json  ====
Line 39: Line 43:
===== 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 09:03, 7 May 2012

Domain Function: updatePrivacy

With this command, you are able to editing the Privacy Protection Status your domain to boxis.net.

Input params

- domain::String::Domain name that you need to Transfer
- protect-privacy::Boolean::Enable / Disable Privacy Protection service. 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
- 'protect-privacy' value is not valid
- this domain belongs to another user
- domain does not exists
- domain not changed