getCategories

Returns all label categories.

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

Parameter

Labeling Description Values margin Default value
format Defines in which format the result will be returned. json|xml json

Return values

Labeling Description Values margin
name Contains a projectcategory. (A-Z|a-z|0-9)+

Messages

Message Description
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.

Exemplary code

  $root = 'https://suite.xovi.net/api/';

 $arrayParams = array(
 'service' =>'project',
 'method' =>'getCategories',
 'key' ='myPersonalKey',
 'format' =>'json',
 );

$GETparams = http_build_query($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":[
        {
            "name":"projects"
        },
        {
            "name":"keywords"
        }
]}
 

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <categorys>
            <category>
                <name>projects</name>
            </category>
         </categorys>
     </apiResult>
</result>