Difference between revisions of "Modifying the Privacy Protection Status"

From Boxis.net API Docs
Jump to: navigation, search
Line 15: Line 15:
 
==== example in XML ====
 
==== example in XML ====
  
===== Success =====
+
===== success =====
  
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 25: Line 25:
 
</return>
 
</return>
  
===== Error =====
+
===== error =====
  
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 37: Line 37:
 
==== 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 13:54, 2 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