deleteEntry
Entfernt einen Kalendereintrag.
Route |
/calendar/deleteEntry[/:key[/:hash[/:format]]] |
Erforderliche Parameter |
hash |
Optionale Parameter |
format |
Rückgabewerte |
hash
|
Querschnittverbindungen |
getEntries() – enthält Hashes der Kalendereinträge. |
Hinweise |
– |
Parameter
Bezeichnung |
Beschreibung |
Wertebereich |
Standardwert |
format |
Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. |
json|xml |
json |
hash |
Id des Kalendereintrages. |
string |
– |
Rückgabewerte
Bezeichnung |
Beschreibung |
Wertebereich |
hash |
Id des Kalendereintrages |
(a-z0-9){32} |
Meldungen
Nachricht |
Beschreibung |
no permission |
Der Schlüssel hat keinen Zugriff auf diese Funktion. |
internal error |
Ein interner Fehler ist aufgetreten. |
param missing |
Ein erforderlicher Parameter wurde nicht übergeben. |
value invalid |
Der Wert eines übergebenen Parameters ist nicht gültig. |
result empty |
Die Bearbeitung der Anfrage war erfolgreich, aber das Ergebnis ist leer. |
cost error |
Der aktuelle Kreditumfang reicht nicht aus, um die Anfrage zu bearbeiten. |
0k. |
Die Bearbeitung der Anfrage war erfolgreich. |
Beispielcode
$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;
Beispielergebnisse
JSON
{
"apiErrorCode":0,
"apiErrorMessage":"0k.",
"apiResult":[
{
"hash": "b4b292d0c16f20eee10a7754539a189c"
}
]
}
XML
<?xml version="1.0"?>
<result>
<apiErrorCode>0</apiErrorCode>
<apiErrorMessage>0k.</apiErrorMessage>
<apiResult>
<entries>
<entrie>
<hash>3957d580698c3345c9a962e077c44961</hash>
</entrie>
</entries>
</apiResult>
</result>