getEntries
Gibt die Einträge des Kalenders zurück.
Route | /calendar/getEntries[/:key[/:format[/:limit[/:skip[/:projhash[/:eventType]]]]]] |
---|---|
Erforderliche Parameter | – |
Optionale Parameter | format limit (max:1000) skip projhash eventType |
Rückgabewerte | hash projhash eventType starttime endtime title description status priority progress |
Querschnittverbindungen | getProjects() – enthält projekthashes. |
Hinweise | type: Wenn der type ‚todo‘ ist, werden priority, status und progress mitgeliefert. Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip. resultCount: Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt. |
Parameter
Bezeichnung | Beschreibung | Wertebereich | Standardwert |
---|---|---|---|
format | Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. | json|xml | json |
limit | Legt fest wieviele Datensätze maximal zurückgegeben werden sollen. (max:1000) | 0-1000 | 100 |
skip | Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit. | integer | 0 |
projhash | Es werden nur die Nachrichten angezeigt, die mit dem Hash verknüpft sind. | string | – |
eventType | Es werden nur Nachrichten zurückgegeben, die dem Eventtypen entsprechen. | note|todo|event | alle |
Rückgabewerte
Bezeichnung | Beschreibung | Wertebereich |
---|---|---|
hash | Id der Organisation | string |
projhash | Hash des zugeordneten Projektes. | string |
eventType | Typ des Kalendereintrages. | note|todo|event |
starttime | Beginn des Kalendereintrages. | YYYY-MM-DD H:M:S |
endtime | Ende des Kalendereintrages. | YYYY-MM-DD H:M:S |
title | titel | string |
description | Beschreibung | string |
status | Status der Aufgabe. Sofern der Eventtyp ‚todo‘ ist. | processing|pending|done |
priority | Priorität der Aufgabe. Sofern der Eventtyp ‚todo‘ ist. | string |
progress | Fortschritt der Aufgabe. Sofern der Eventtyp ‚todo‘ ist. | int |
Meldungen
Nachricht | Beschreibung |
---|---|
maximum limit exeeded | Das maximale Limit wurde überschritten. |
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/'; $arrayParams = array( 'service' => 'calendar', 'method' => 'getEntries', 'key' => 'myPersonalKey', ); $GETparams = implode('/', $arrayParams); $requestURL = $root.$GETparams; 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.", "apiMeta": {"resultCount":"1"}, "apiResult": [{ "hash": "b4b292d0c16f20eee10a7754539a189c", "projectHash": "dljkl342lkjsfoi34rswerkj", "type": "event", "starttime": "2015-12-12 19:07:06", "endtime": "2015-12-12 20:50:00", "title": "My Event", "description": "This is a description" }] }
XML
<?xml version="1.0" encoding="UTF-8"?> <result> <apiMeta> <resultCount>1</resultCount> </apiMeta> <apiErrorCode>0</apiErrorCode> <apiErrorMessage>0k.</apiErrorMessage> <apiResult> <entries> <entrie> <hash>3957d580698c3345c9a962e077c44961</hash> <projectHash>lökjdsfd34234oijulk</projectHash> <type>event</type> <starttime>2016-12-12 12:12:12</starttime> <endtime>2016-12-12 12:12:12</endtime> <title>myTitle</title> <description>myDescription</description> </entrie> </entries> </apiResult> </result>