View source for Modifying the Privacy Protection Status

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


== Example URL with POST values ==

<pre>
http://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337854111&username=your@mail.com&authcode=1234567890&section=domains&action=updatePrivacy&domain=test1.com&protect-privacy=1
</pre>

== Output params ==

==== Example in XML (Success) ====

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params/>
  <timestamp>1335767184</timestamp>
</return>
</pre>

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

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>0</result>
  <resulttxt>Error: {error description}</resulttxt>
  <params/>
  <timestamp>1335767184</timestamp>
</return>
</pre>

==== Example in JSON (Success) ====

<pre>
{"result":"1",
 "resulttxt":"success",
 "params":[],
 "timestamp":1335777400}
</pre>

==== Example in JSON (Error) ====

<pre>
{"result":"0",
 "resulttxt":"Error: {error description}",
 "params":[],
 "timestamp":1335777400}
</pre>


== Example using our PHP Class ==

<pre>
/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey   = '1234567890';        // your apikey

/* API COMMAND DETAILS */
$apitype  = 'domains';
$command  = 'updatePrivacy';
$params   = array(
    'returntype' => 'xml',
    'domain' => 'test1.com',
    'protect-privacy' => 1
);

/* PROCESS THE ACTION */
$boxisAPI = new BoxisAPIConnection($email, $apikey);
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);

/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)
if($return['timestamperror']) {
    $timestamp = $return['timestamp'];
    $return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);
}
*/

/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/
/*
if($return->timestamperror) {
    $timestamp = $return->timestamp;
    $return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);
}
/*

</pre>