Difference between revisions of "Modifying the Protection Lock Status"

From Boxis.net API Docs
Jump to: navigation, search
(Example URL with POST values)
 
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
With this command, you are able to editing the Protection Lock Status your domain to boxis.net.
 
With this command, you are able to editing the Protection Lock 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 'updateLock' value
 
|-
 
| - '''domain''' (String)
 
''Domain name that you need to change''
 
|-
 
| - '''protection-lock''' (Boolean)
 
''Enable / Disable Protection Lock service. Possible values are: 1 or 0''
 
|}
 
  
=== Output params ===
+
== 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 'updateLock' value
 +
 
 +
*'''domain'''::String - ''Domain name that you need to change''
 +
 
 +
*'''protection-lock'''::Boolean - ''Enable / Disable Protection Lock 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=updateLock&domain=test1.com&protect-privacy=1
 +
</pre>
 +
 
 +
== Output params ==
  
 
==== Example in XML (Success) ====
 
==== Example in XML (Success) ====
Line 57: Line 56:
 
</pre>
 
</pre>
  
==== Example in Json (Success) ====
+
==== Example in JSON (Success) ====
  
 
<pre>
 
<pre>
Line 66: Line 65:
 
</pre>
 
</pre>
  
==== Example in Json (Error) ====
+
==== Example in JSON (Error) ====
  
 
<pre>
 
<pre>
Line 73: Line 72:
 
  "params":[],
 
  "params":[],
 
  "timestamp":1335777400}
 
  "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  = 'updateLock';
 +
$params  = array(
 +
    'returntype' => 'xml',
 +
    'domain' => 'test1.com',
 +
    'protection-lock' => 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>
 
</pre>

Latest revision as of 12:55, 26 October 2012

Domain Function: updateLock

With this command, you are able to editing the Protection Lock 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 'updateLock' value
  • domain::String - Domain name that you need to change
  • protection-lock::Boolean - Enable / Disable Protection Lock service. Possible values are: 1 or 0


Example URL with POST values

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

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}


Example using our PHP Class

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

/* API COMMAND DETAILS */
$apitype  = 'domains';
$command  = 'updateLock';
$params   = array(
    'returntype' => 'xml',
    'domain' => 'test1.com',
    'protection-lock' => 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);
}
/*