addLabel

Adds one or more labels.

Route /project/addLabel[/:key[/:name[/:category[/:format]]]]
Necessary parameter name
category
Optional parameter format
Return values hash
name
Cross references getCategories
Hints

Parameters

Labeling Description Values margin Default value
Category Contains a category (A-Z|a-z)+
name Describes a label (A-Z|a-z)+
format Defines in which format the result will be returned. json|xml json

Return values

Labeling Description Values margin
hash Numeric identifier. (0-9)+
name Contains the name (A-Z|a-z|0-9)+

Messages

Message Description
no permission The key has no access to this function.
internal error An internal error occured.
param missing A required parameter is missing.
param 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.

Examplary Code

$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
'service' =>'project',
 'method' =>'addLabel',
 'key' =>'myPersonalKey',
 'name' =>'newproject',
 '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;
?>

Exemplary results

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>