deleteEntry

Removes a calendarentry.

Route /calendar/deleteEntry[/:key[/:hash[/:format]]]
required Parameters hash
Optional Parameters format
return values hash
cross references getEntries() – returns hashes of the calendarentries.
hints

Parameters

labeling description valuemargin default
format Defines in which format the result will be returned. json|xml json
hash Id of the calendarentry. string

Return values

labeling description valuemargin
hash Id of the calendarentry string

Messages

Message description
no permission The key has no permission to access this function.
internal error An internal error occured.
param missing A required parameter is missing.
value invalid The value of a parameter is not valid.
result empty The request was successful, but the result itself is empty.
cost error The current credit amount is not sufficient to handle the request.
0k. The processing was successful.

Example code

$root = 'https://suite.xovi.net/api/';
$arrayPath = array(
    'service' =>'calendar',
    'method'  =>'deleteEntry',
    'key' => 'myKey',
    'hash' => 'hashOfCalendarEntry',
);
$pathString = implode('/', $arrayPath);
$requestURL = $root.$pathString;

if (!function_exists('curl_init')) die('cURL not available');

$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_URL, $requestURL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Download the given URL, and return output
$output = curl_exec($ch);

// Close the cURL resource, and free system resources
curl_close($ch);

echo $output;
?>

Example results

JSON

{
	"apiErrorCode": 0,
	"apiErrorMessage": "0k.",
	"apiResult": [{
		"hash": "b4b292d0c16f20eee10a7754539a189c"
	}]
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<result>
 <apiErrorCode>0</apiErrorCode>
 <apiErrorMessage>0k.</apiErrorMessage>
 <apiResult>
     <entries>
         <entrie>
         <hash>3957d580698c3345c9a962e077c44961</hash>
        </entrie>
     </entries>
 </apiResult>
</result>