...
EFS Service Layer, unsere API in EFS, ermöglicht den Zugriff auf EFS Kern-Funktionalitäten durch externe Anwendungen. Somit können Anwendungen, die auf EFS-Daten und -Funktionalitäten beruhen, außerhalb von EFS mit verschiedenen Technologien erstellt werden. Die Dienste können von außen über HTTPS aufgerufen werden, wobei SOAP oder REST als Protokolle verwendet werden können. Es können verschiedene Datenaustauschformate verwendet werden (z.B. JSON oder XML).
Eine Übersicht aller EFS Service-Layer Methoden finden Sie in der englischsprachigen EFS Dokumentation. Aufgrund der Komplexität und Umfang dieser Liste, kann dieses Dokument aktuell nur auf Englisch zur Verfügung gestellt werden. Wir bitten um Ihr Verständnis.
...
Die auf Ihrer EFS-Installation verfügbaren Services können in einem speziell eingerichteten Konfigurations-Menü eingesehen und konfiguriert werden. Das Menü befindet sich im Administrationsbereich von EFS unter Optionen → Service-Layer. Das Menü Service-Layer ist grundsätzlich nur verfügbar, wenn Questbacks das Support-Team auf Ihrer Installation die Nutzung von Services freigeschaltet hat. Für den Zugang zum Menü ist entweder Schreibrecht auf das ACL-Recht webservice_conf oder Mitgliedschaft im Root-Team erforderlich.
...
Der jeweilige Service muss von Questbacks dem Support-Team hinzugefügt werden.
Der Service muss aktiviert werden. Falls erforderlich, können mit dem Button Alle Services aktivieren auch sämtliche auf der Installation vorhandenen Services en bloc aktiviert werden.
Das Mitarbeiterteam, zu dem der Account gehört, mit dem auf einen Service zugegriffen wird, muss Zugriffsrecht für diesen Service haben. Auf der Registerkarte Zugriffsgruppen können die Zugriffsrechte auf die einzelnen Services separat definiert werden.
Des Weiteren beinhalten viele Services eine Prüfung auf die Objektrechte des Mitarbeiterteams. Bei survey.questionnaire.createPage oder survey.questionnaire.deletePage beispielsweise benötigt das Mitarbeiterteam Schreibrecht auf das betreffende Projekt.
Auf der Registerkarte Zugriffslog werden alle Aufrufe geloggt. Die Einträge können nach IP-Adresse, Name des verwendeten Adminaccounts, Service-Name und Datum durchsucht werden.
...
| Expand |
|---|
| title | Example: JSON call with http authentication using PHP and Zend Framework |
|---|
|
| Code Block |
|---|
| <?php
/* Example requires Zend Framework */
require_once('Zend/Loader/Autoloader.php');
function serviceLayerCall($method, $params=null)
{
$autoloader = Zend_Loader_Autoloader::getInstance();
$url="http://EFSINSTALLATIONURL/service/index.php?handler=json&token=TOKEN";
$client = new Zend_Http_Client();
$client->setUri($url);
$client->setConfig(array('timeout' => 30));
$client->setMethod(Zend_Http_Client::POST);
/* not using TOKEN? Here is basic auth: */
//$user = "USER";
//$passwd = "PASSWORD";
//$client->setAuth($user, $passwd);
$client->setRawData(json_encode(array('method' => $method, 'jsonrpc' => '2.0', 'id' => 1, 'params' => $params)));
$request = $client->request();
//print "<pre>";
//var_dump($request->getBody());
$return = json_decode($request->getBody());
$return=$return->result;
return $return->return;
}
/* 1. Step - Get projects
*/
print "<h3>1. step - get projects</h3>";
$projects=serviceLayerCall("survey.surveys.getList");
foreach($projects as $project)
{
print "- ".$project->title." (".$project->id.")<br>";
}
//2. Step - Get Structure for Pid 1112
, first a helper function:
function sub($pages, &$myquestions)
{
foreach($pages as $page)
{
if(count($page->subPages) > 0)
$this->sub($page->subPages, $myquestions);
foreach($page->questions as $question)
{
$myquestions[]=$question;
}
}
return $myquestions;
}
$relevantVars=array();
print "<hr><h3>2. step - get structure for Pid 1112</h3>";
$project=serviceLayerCall("survey.surveys.getQuestionnaireStructure", array("surveyId" => 1112));
$questions=sub($project, $myquestions);
foreach($questions as $question)
{
if($question->questiontext) {
print $question->questiontext . "<br>";
foreach ($question->variables as $variable) {
if ($variable->type == "char" || $variable->type == "text") {
print "Text-Var: ".$variable->varname . "<br>";
//add to $relevantVars for export
$relevantVars[] = $variable->varname;
}
}
}
}
/* 3 - Relevant vars for export */
print "<hr><h3>3. Collected variables for export:</h3>";
var_dump($relevantVars);
print "</pre>";
/* 4 - Get CSV export */
print "<hr><h3>4. Get results for specific vars</h3>";
$exportData=serviceLayerCall("survey.results.getRawdataCSV", array("surveyId" => 1112, "exportTypes" => array("QUESTIONNAIRE"), "includeVariables" => $relevantVars));
print base64_decode($exportData); |
|
...
Verfügbare Service Layer Methoden
Eine Übersicht aller EFS Service-Layer Methoden finden Sie in der englischsprachigen EFS Dokumentation.