deleteLabel

Entfernt ein Label.

Route	/project/deleteLabel[/:key[/:hash[/:format]]]
required parameters	hash
Optional Parameters	format
return values	hash
cross references	getLabels() – contains hashes of the labels
hints	–

Parameters

labeling	description	valuemargin	defaultvalue
format	Defines in which format the result will be returned.	json|xml	json
hash	Id of the label.	string	–

Return values

labeling	description	value margin
hash	Id of the label	(a-z0-9)+

Meldungen

Nachricht	Beschreibung
no permission	The key has no permission to access this function.
internal error	An internal error occured.
param missing	A required parameter is missing.
value invalid	The value of a parameter is not valid.
result empty	The request was successful, but the result itself is empty.
cost error	The current credit amount is not sufficient to handle the request.
0k.	The processing was successful.

Examplecode

$root = 'https://suite.xovi.net/api/';
$arrayPath = array(
    'service' =>'project',
    'method'  =>'deleteLabel',
    'key' => 'myKey',
    'hash' => 'hashOfLabel',
);
$pathString = implode('/', $arrayPath);
$requestURL = $root.$pathString;

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;

Exampleresult

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>