addLabel

Fügt neue Labels hinzu.

Route /project/addLabel[/:key[/:name[/:category[/:format]]]]
Erforderliche Parameter name
category
Optionale Parameter format
Rückgabewerte hash
name
Querschnittverbindungen getCategories
Hinweise

Parameter

Bezeichnung Beschreibung Wertebereich Standardwert
category Beschreibt zu welcher Kategorie das Label gehören soll. (A-Z|a-z)+
name Beschreibt ein Label. (A-Z|a-z)+
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json

Rückgabewerte

BEZEICHNUNG Beschreibung WERTEBEREICH
hash Enthält einen eindeutigen Bezeichner des angelegten Labels. (0-9)+
name Enthält die Bezeichnung des angelegten Labels. (A-Z|a-z|0-9)+

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/';
$arrayParams = array(
'service' =>'project',
 'method' =>'addLabel',
 'key' =>'myPersonalKey',
 'name' =>'newlabel',
 'category' => 'projects'
 );
$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":"1",
         "name":"newlabel"
     }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <labels>
            <label>
                 <hash>1</hash>
                 <name>newlabel</name>
            </label>
        </labels>
    </apiResult>
</result>