getCreditstate

Gibt Ihre aktuellen Creditdaten zurück.

Route	/user/getCreditstate[/:key[/:format]]
Erforderliche Parameter	–
Optionale Parameter	format
Rückgabewerte	creditamount additinalCreditamount bookedCreditamount refillintervall lastrefill creditsleft creditsused
Querschnittverbindungen	–
Hinweise	–

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standardwert
format	Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll.	json|xml	json

Rückgabewerte

Bezeichnung	Beschreibung	Wertebereich
creditamount	Zeigt den monatlich zur Verfügung stehenden Creditumfang.	(0-9)+
additinalCreditamount	Zeigt an, wie hoch der zusätzlich gebuchte Creditumfang ist.	(0-9)+
bookedCreditamount	Zeigt an, wie hoch der zusätzlich angefragte Creditumfang ist.	(0-9)+
refillintervall	Zeigt an, in welchem Abstand (Monate) das Creditkonto aufgefüllt wird.	1
lastrefill	Zeigt an, wann der Creditumfang das letzte Mal aufgefüllt wurde.	(0-9){4}-(0-9){2}-(0-9){2}
creditsleft	Enthält die bis zum nächsten Refill verfügbaren Credits.	(0-9)+
creditsused	Enthält die seit dem letzten Refill verbrauchten Credits.	(0-9)

Meldungen

Nachricht	Beschreibung
internal error	Ein interner Fehler ist aufgetreten.
param missing	Ein erforderlicher Parameter wurde nicht übergeben.
param 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/';
$arrayParams = array(
    'service' => 'user',
    'method'  => 'getCreditstate',
    'key'     => 'myPersonalKey',
    'format'  => 'json',
);
$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;

Beispielergebnisse

JSON

{
    "apiErrorCode":0,
    "apiErrorMessage":"0k.",
    "apiResult":{
        "creditamount":1000,
        "additionalCreditamount":5000,
        "bookedCreditamount":1000,
        "refillintervall":4,
        "lastrefill":"2013-03-08 15:00:00",
        "creditsleft":5280,
        "creditsused":720
    }
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <creditstates>
            <creditstate>
                <creditamount>1000</creditamount>
                <additionalCreditamount>5000</additionalCreditamount>
                <bookedCreditamount>1000</bookedCreditamount>
                <refillintervall>4</refillintervall>
                <lastrefill>2013-03-08 15:00:00</lastrefill>
                <creditsleft>5280</creditsleft>
                <creditsused>720</creditsused>
            </creditstate>
        </creditstates>
    </apiResult>
</result>