getXoviLimits

Returns all limits within the tool.

Route	/user/getXoviLimits[/:key[/:format]]
required parameters	–
Optional Parameters	format
return values	name value
crossreferences	–
hints	–

Parameters

labeling	description	valuemargin	defaultvalues
format	Defines the format of the result.	json|xml	json

Return Values

labeling	description	valuemargin
name	Name of limit	(a-z0-9){32}
value	value of limit	(0-9){32}

Messages

message	description
no permission	the key has no access permission
internal error	An internal error occured.
param missing	The required parameter is missing.
param invalid	The value of a parameter is missing.
result empty	The result is empty
cost error	The current credit amount is not sufficient to handle the request.
0k.	The processing was successful.

EXAMPLE CODE

$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
                     'service' =>'user',
                     'method'  =>'getXoviLimits',
                     'key'     =>'myPersonalKey',
		  );
$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;

EXAMPLE RESULTS

XML

<result>
    <apiMeta/>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <xoviLimits>
            <xoviLimit>
                <name>monitoringKeywords</name>
                <value>5000</value>
            </xoviLimit>
            <xoviLimit>
                <name>socialUrls</name>
                <value>10000</value>
            </xoviLimit>
            <xoviLimit>
                <name>socialKeywords</name>
                <value>50</value>
            </xoviLimit>
            <xoviLimit>
                <name>onpageUrls</name>
                <value>25000</value>
            </xoviLimit>
            <xoviLimit>
                <name>onpageThreads</name>
                <value>1</value>
            </xoviLimit>
            <xoviLimit>
                <name>subaccountsReadwrite</name>
                <value>5</value>
            </xoviLimit>
            <xoviLimit>
                <name>subaccountsReadonly</name>
                <value>30</value>
            </xoviLimit>
            <xoviLimit>
                <name>apiCredits</name>
                <value>373579</value>
            </xoviLimit>
            <xoviLimit> 
                <name>freeExportCredits</name>
                <value>50000</value>
            </xoviLimit>
            <xoviLimit>
                <name>socialProfileProfiles</name>
                <value>100</value>
            </xoviLimit>
            <xoviLimit>
                <name>linkmarkerAnalysises</name>
                <value>1000</value>
            </xoviLimit>
            <xoviLimit>
                <name>linkmarkerUrls</name>
                <value>2050000</value>
            </xoviLimit>
            <xoviLimit>
                <name>webmasterDomains</name>
                <value>10000</value>
            </xoviLimit>
        </xoviLimits>
    </apiResult>
</result>

JSON

{
"apiErrorCode": 0,
"apiErrorMessage": "0k.",
"apiResult": [
{
    "name": "monitoringKeywords",
    "value": 5000
},
{
    "name": "socialUrls",
    "value": 10000
},
{
    "name": "socialKeywords",
    "value": 50
},
{
    "name": "onpageUrls",
    "value": 25000
},
{
    "name": "onpageThreads",
    "value": 1
},
{
    "name": "subaccountsReadwrite",
    "value": 5
},
{
    "name": "subaccountsReadonly",
    "value": 30
},
{
    "name": "apiCredits",
    "value": 373579
},
{
    "name": "freeExportCredits",
    "value": 50000
},
{
    "name": "socialProfileProfiles",
    "value": 100
},
{
    "name": "linkmarkerAnalysises",
    "value": 1000
},
{
    "name": "linkmarkerUrls",
    "value": 2050000
},
{
    "name": "webmasterDomains",
    "value": 10000
}
]
}