editEntry
Ändert einen Kalendereintrag.
Route | /calendar/editEntry[/:key[/:format]] |
---|---|
Erforderliche Parameter | hash (POST) datetimeStart (POST) title (POST) |
Optionale Parameter | projhash (POST) datetimeEnd (POST) description (POST) eventType (POST) priority (POST) progress (POST) status (POST) format |
Rückgabewerte | hash |
Querschnittverbindungen | getProjects() – enthält projekthashes. |
Hinweise | Abhängigkeit: Die Parameter priority, progress und status werden nur berücksichtigt, wenn der Parameter eventType den Wert ‚todo‘ hat. POST: Alle Parameter, die nicht in der Route enthalten sind, werden per POST versendet. |
Parameter
Bezeichnung | Beschreibung | Wertebereich | Standardwert |
---|---|---|---|
projhash | Projekt wird diesem Eintrag zugeordnet. | siehe getProjects() | – |
format | Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. | json|xml | json |
datetimeStart | Startpunkt des Ereignisses. | YYYY-MM-DD H:M:S | – |
datetimeEnd | Endpunkt des Ereignisses. | YYYY-MM-DD H:M:S | – |
title | Titel | string | – |
description | Beschreibung | string | – |
eventType | Legt fest, um welchen Ereignistypen es sich handelt. | note|todo|event | – |
priority | Für den Fall, dass es sich um den Ereignistypen (eventType) todo handelt, kann eine Priorität festgelegt werden. | urgent|high|normal|low | – |
progress | Für den Fall, dass es sich um den Ereignistypen (eventType) todo handelt, kann der prozentuale Stand der Aufgabe festgehalten werden. | 0 bis 100 | – |
status | Für den Fall, dass es sich um den Ereignistypen (eventType) todo handelt, kann der Status der Aufgabe festgehalten werden. | pending|processing|done | – |
Rückgabewerte
Bezeichnung | Beschreibung | Wertebereich |
---|---|---|
hash | Id der Organisation | (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. |
param 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' => 'editEntry', 'key' => 'myAPIKey', ); $pathString = implode('/', $arrayPath); $requestURL = $root.$pathString; //build POST query $arrayParams = array( 'hash' => '1231lk23jlkjf3ij42309', 'datetimeStart' => '2015-11-16 19:12:12', 'title' => 'new Entry' ); $paramsString = http_build_query($arrayParams); 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); //setup POST curl_setopt($ch, CURLOPT_POST, count($arrayParams)); curl_setopt($ch, CURLOPT_POSTFIELDS, $paramsString); // 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" encoding="UTF-8"?> <result> <apiErrorCode>0</apiErrorCode> <apiErrorMessage>0k.</apiErrorMessage> <apiResult> <entries> <entrie> <hash>3957d580698c3345c9a962e077c44961</hash> </entrie> </entries> </apiResult> </result>