getLabels

Gibt alle angelegten Labels zurück.

Route	/project/getLabels[/:key[/:category[/:format[/:limit[/:skip]]]]]
Erforderliche Parameter	–
Optionale Parameter	category format limit (max:1000) skip
Rückgabewerte	hash name
Querschnittverbindungen	getCategories
Hinweise	limit – Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip.

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
category	Legt fest zu welchen Kategorien das Ergebnis zurückgeliefert werden soll.	siehe getCategories	NULL
format	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	json|xml	json
limit	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	0-1000	100
skip	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	(0-9)+	0

Rückgabewerte

BEZEICHNUNG	Beschreibung	WERTEBEREICH
hash	Enthält einen eindeutigen Bezeichner des angelegten Labels.	(a-z0-9)+
name	Enthält die Bezeichnung des angelegten Labels.	(A-Z|a-z|0-9)+
categories	Enthält ein Array mit Kategorien, denen das Label zugeordnet ist.	siehe getCategories

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'  => 'project',
    'method'   => 'getLabels',
    'key'      => 'myPersonalKey',
    'category' => 'projects',
    'format'   => 'xml',
);
$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.",
    "apiResult":[{
        "hash":"fa942d41894665aa",
        "name":"apilabel",
        "categories":{
            "category0":"projects",
            "category1":"keywords"
        }
    }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <labels>
            <label>
                <hash>fa942d41894665aa</hash>
                <name>apilabel</name>
                <categories>
                    <category0>projects</category0>
                    <category1>keywords</category1>
                </categories>
            </label>
        </labels>
    </apiResult>
 </result>