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 6: Line 6:
{|
{|
|-
|-
| - '''domain'''::String::Domain name that you need to Transfer
| - '''version''' (String)
''API version (e.g. '1.0')''
|-
|-
| - '''protect-privacy'''::Boolean::Enable / Disable Privacy Protection service. Possible values are: 1 or 0
| - '''timestamp''' (String)
''Sequence of characters, denoting the date and time (e.g '1336553826')''
|-
| - '''username''' (String)
''User e-mail address (e.g 'mail1@example.com')''
|-
| - '''authcode''' (String)
'' md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))''
|-
| - '''section''' (String)
''API module name. Use 'domains' value
|-
| - '''action''' (String)
''API module function. Use 'updatePrivacy' value
|-
| - '''domain''' (String)
''Domain name that you need to change''
|-
| - '''protect-privacy''' (Boolean)
''Enable / Disable Privacy Protection service. Possible values are: 1 or 0''
|}
|}


=== Output params ===
=== Output params ===


==== example in XML ====
==== Example in XML (Success) ====
 
===== success =====


<pre>
<pre>
Line 27: Line 45:
</pre>
</pre>


===== error =====
==== Example in XML (Error) ====


<pre>
<pre>
Line 39: Line 57:
</pre>
</pre>


==== Example in Json ====
==== Example in Json (Success) ====
 
===== success =====


<pre>
<pre>
Line 50: Line 66:
</pre>
</pre>


===== error =====
==== Example in Json (Error) ====


<pre>
<pre>
Line 58: Line 74:
  "timestamp":1335777400}
  "timestamp":1335777400}
</pre>
</pre>
==== 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
|}

Revision as of 20:42, 9 May 2012

Domain Function: updatePrivacy

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

Input params

- version (String)

API version (e.g. '1.0')

- timestamp (String)

Sequence of characters, denoting the date and time (e.g '1336553826')

- username (String)

User e-mail address (e.g 'mail1@example.com')

- authcode (String)

md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))

- section (String)

API module name. Use 'domains' value

- action (String)

API module function. Use 'updatePrivacy' value

- domain (String)

Domain name that you need to change

- 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>

Example in XML (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}

Example in Json (Error)

{"result":"0",
 "resulttxt":"Error: {error description}",
 "params":[],
 "timestamp":1335777400}
Retrieved from "https://apidocs.boxis.net/index.php?title=Modifying_the_Privacy_Protection_Status&oldid=139"