getPdf

Gibt einen bereits erstellten Report als PDF zurück.

Route /report/getPdf[/:key[/:id[/:format]]]
Erforderliche Parameter id
Optionale Parameter format
Rückgabewerte name
file
Querschnittverbindungen getDownloads()
Hinweise Wählen Sie „json“ oder „xml“ als Format, erhalten Sie die PDF als Base64 String im Feld „file“ und den Namen der Datei im Feld „name“.Wählen Sie „pdf“ als Format, erhalten Sie die PDF-Datei.

Parameter

Bezeichnung Beschreibung Wertebereich Standardwert
id Enthält einen eindeutigen Bezeichner für einen bereits erstellten und downloadbaren Report. (0-9)+
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml|pdf json

Rückgabewerte

Bezeichnung Beschreibung
name Enthält einen eindeutigen Bezeichner für einen bereits erstellten und downloadbaren Report.
file Enthält eine PDF-Datei.

Meldungen

Nachricht Beschreibung
no permission Der Schlüssel hat keinen Zugriff auf diese Funktion.
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'   =>'report',
    'method'    =>'getPdf',
    'key'       =>'myPersonalKey',
    'id'        =>'getDownloads-Id',
    'format'    =>'pdf',
);
$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":[
     {
         "name":"xovi.de (-) GOOGLE.DE 2013-03-10 (---) 2013-03-11.pdf",
         "file":"JVBERi0xLj...IC9TIC9Ucm"
     }]
}

XML

<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <pdfs>
            <pdf>
                <name>xovi.de (-) GOOGLE.DE 2013-03-10 (---) 2013-03-11.pdf</name>
                <file>JVBERi0xLj...IC9TIC9Ucm</file>
            </pdf>
        </pdfs>
    </apiResult>
</result>