editLabel

Ändert ein Label.

Route /project/editLabel[/:key[/:hash[/:name[/:format]]]]
Erforderliche Parameter hash
Optionale Parameter name
categories (POST)
format
Rückgabewerte hash
Querschnittverbindungen getLabels() – enthält Hashes der Labels.
getCategories() – enthält die möglichen Kategorien
Hinweise categories – Wenn Kategorien übergeben werden, wird die vorhandene Zuordnung des Labels zu den Kategorien mit der übermittelten Zuordnung überschrieben.
POST – POST Variablen sollten UTF8 kodiert sein.

Parameter

Bezeichnung Beschreibung Wertebereich Standardwert
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json
hash Id des Labels. string
name Name des Labels string bestehender name
categories Array mit Kategorien denen das Label zugeordnet sein soll. array bestehende Zuordnung

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
hash Id des Labels (a-z0-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.
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' =>'project',
    'method'  =>'editLabel',
    'key' => 'myKey',
    'hash' => 'hashOfLabel',
    'name' => 'nameChanged',
);
$pathString = implode('/', $arrayPath);
$requestURL = $root.$pathString;

$arrayParams = array(
    'categories' => array(
        'keywords'
    )
);
$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": "b4b292d0c16f2"
	}]
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<result>
 <apiErrorCode>0</apiErrorCode>
 <apiErrorMessage>0k.</apiErrorMessage>
 <apiResult>
     <entries>
         <entrie>
         <hash>b4b292d0c16f2</hash>
        </entrie>
     </entries>
 </apiResult>
</result>