Difference between revisions of "Modifying the Auto-Renewal Status"

From Boxis.net API Docs
Jump to: navigation, search
(Created page with "=Domain Function: updateAutoRenew= With this command, you are able to editing the Auto-Renewal Status your domain to boxis.net. === Input params === {| |- | - '''domain'''::...")
 
(→‎Example URL with POST values)
 
(8 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
With this command, you are able to editing the Auto-Renewal Status your domain to boxis.net.
 
With this command, you are able to editing the Auto-Renewal Status your domain to boxis.net.
  
−
=== Input params ===
 
−
{|
 
−
|-
 
−
| - '''domain'''::String::Domain name that you need to Transfer
 
−
|-
 
−
| - '''autorenew'''::Boolean::Enable / Disable Auto-Renewal service. Possible values are: 1 or 0
 
−
|}
 
  
−
=== Output params ===
+
== Input params ==
  
−
==== example in XML ====
+
*'''version'''::String - ''API version (e.g. '1.0')''
  
−
===== Success =====
+
*'''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 'updateAutoRenew' value
 +
 +
*'''domain'''::String - ''Domain name that you need to change''
 +
 +
*'''autorenew'''::Boolean - ''Enable / Disable Auto-Renewal 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=updateAutoRenew&domain=test1.com&protect-privacy=1
 +
</pre>
 +
 +
== Output params ==
 +
 +
==== Example in XML (Success) ====
 +
 +
<pre>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<return>
 
<return>
Line 24: Line 42:
 
   <timestamp>1335767184</timestamp>
 
   <timestamp>1335767184</timestamp>
 
</return>
 
</return>
 +
</pre>
  
−
===== Error =====
+
==== Example in XML (Error) ====
  
 +
<pre>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<return>
 
<return>
Line 34: Line 54:
 
   <timestamp>1335767184</timestamp>
 
   <timestamp>1335767184</timestamp>
 
</return>
 
</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 ==
  
−
==== Example in Json  ====
+
<pre>
 +
/* API LOGIN DETAILS */
 +
$email    = 'your@mail.com';    // your username
 +
$apikey  = '1234567890';        // your apikey
  
−
===== Success =====
+
/* API COMMAND DETAILS */
 +
$apitype  = 'domains';
 +
$command  = 'updateAutoRenew';
 +
$params  = array(
 +
    'returntype' => 'xml',
 +
    'domain' => 'test1.com',
 +
    'autorenew' => 1
 +
);
  
−
{"result":"1","resulttxt":"success","params":[],"timestamp":1335777400}
+
/* PROCESS THE ACTION */
 +
$boxisAPI = new BoxisAPIConnection($email, $apikey);
 +
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);
  
−
===== Error =====
+
/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)
 +
if($return['timestamperror']) {
 +
    $timestamp = $return['timestamp'];
 +
    $return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);
 +
}
 +
*/
  
−
{"result":"0","resulttxt":"Error: {error description}","params":[],"timestamp":1335777400}
+
/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/
 +
/*
 +
if($return->timestamperror) {
 +
    $timestamp = $return->timestamp;
 +
    $return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);
 +
}
 +
/*
  
−
==== Errors Descriptions ====
+
</pre>
−
{|
+
−
|-
+
−
| - 'domain' is not valid
+
−
|-
+
−
| - 'autorenew' value is not valid
+
−
|-
+
−
| - this domain belongs to another user
+
−
|-
+
−
| - domain does not exists
+
−
|-
+
−
| - domain not changed
+
−
|}
+

Latest revision as of 13:56, 26 October 2012

Domain Function: updateAutoRenew

With this command, you are able to editing the Auto-Renewal 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 'updateAutoRenew' value
  • domain::String - Domain name that you need to change
  • autorenew::Boolean - Enable / Disable Auto-Renewal 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=updateAutoRenew&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  = 'updateAutoRenew';
$params   = array(
    'returntype' => 'xml',
    'domain' => 'test1.com',
    'autorenew' => 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);
}
/*
Retrieved from "https://apidocs.boxis.net/index.php?title=Modifying_the_Auto-Renewal_Status&oldid=326"