Beide Seiten der vorigen RevisionVorhergehende Überarbeitung | Nächste ÜberarbeitungBeide Seiten der Revision |
de:results:data-api [16.04.2019 15:35] – [CSV für R] jan.everding | de:results:data-api [29.04.2019 16:05] – admin |
---|
| |
Standardmäßig liefert der API-Link alle erhobenen Daten (entsprechend den im API-Link festgelegten Auswahlkriterien). | Standardmäßig liefert der API-Link alle erhobenen Daten (entsprechend den im API-Link festgelegten Auswahlkriterien). |
| |
| |
==== Ausgabe ==== | ==== Ausgabe ==== |
* ''data''\\ Der Datensatz, wobei die einzelnen Fälle als Attribute mit dem Schlüssel ''C'' + Nummer des Datensatzes (CASE) vorliegen. | * ''data''\\ Der Datensatz, wobei die einzelnen Fälle als Attribute mit dem Schlüssel ''C'' + Nummer des Datensatzes (CASE) vorliegen. |
* ''C213''\\ Die einzelnen Fälle (Zeilen im Datensatz) sind als Objekte mit den Variablennamen als Schlüsseln und deren Ausprägung als Wert definiert. Falls für eine Variable keine Angabe vorliegt (nicht abgefragt oder keine Angabe in einer offenen Frage), wird diese __nicht__ gelistet. | * ''C213''\\ Die einzelnen Fälle (Zeilen im Datensatz) sind als Objekte mit den Variablennamen als Schlüsseln und deren Ausprägung als Wert definiert. Falls für eine Variable keine Angabe vorliegt (nicht abgefragt oder keine Angabe in einer offenen Frage), wird diese __nicht__ gelistet. |
| * ''variables''\\ Informationen zu den Variablen und Antwortcodes, die im Datensatz Verwendet werden (nur vorhanden, wenn die Parameter "infoVariables", "infoValues" und/oder "infoQuestionText" angegeben wurden). |
| |
<code json> | <code json> |
* Es kann auch eine einzelne Fall-Nummer angegeben werden. | * Es kann auch eine einzelne Fall-Nummer angegeben werden. |
* **Hinweis:** Falls mehr Fälle angegeben werden als im API-Link erlaubt, wird der Bereich entsprechend eingeschränkt. Wenn also z.B. der API-Link den Bereich ''1-100'' erlaubt und der Parameter ''cases'' den Bereich ''50-150'' abrufen möchte, so werden die Fälle 50 bis 100 abgerufen. | * **Hinweis:** Falls mehr Fälle angegeben werden als im API-Link erlaubt, wird der Bereich entsprechend eingeschränkt. Wenn also z.B. der API-Link den Bereich ''1-100'' erlaubt und der Parameter ''cases'' den Bereich ''50-150'' abrufen möchte, so werden die Fälle 50 bis 100 abgerufen. |
| * Die Angabe des Parameters ''none'' deaktiviert den Abruf von Daten, wenn z.B. nur die Variablen und/oder Antwortcodes abgerufen werden sollen. |
* ''vList'' -- Variablen, die abgerufen werden sollen. | * ''vList'' -- Variablen, die abgerufen werden sollen. |
* Wenn der Parameter ''vList'' angegeben ist, werden nur (!) die angegeben Variablen abgerufen. | * Wenn der Parameter ''vList'' angegeben ist, werden nur (!) die angegeben Variablen abgerufen. |
* ''changed'' -- Nur Fälle abrufen, die zuletzt nach diesem Zeitpunkt geändert wurden. | * ''changed'' -- Nur Fälle abrufen, die zuletzt nach diesem Zeitpunkt geändert wurden. |
* Es ist möglich, dass Interviews während des Abrufs noch nicht abgeschlossen sind. Wenn man beim nächsten Abruf der Daten den Zeitpunkt des vorigen Abrufs als ''changed'' angibt, erhält man alle seit dem letzten Abruf geänderten Fälle. | * Es ist möglich, dass Interviews während des Abrufs noch nicht abgeschlossen sind. Wenn man beim nächsten Abruf der Daten den Zeitpunkt des vorigen Abrufs als ''changed'' angibt, erhält man alle seit dem letzten Abruf geänderten Fälle. |
| * ''infoVariables'' -- Daten- und Abfrageformat von Variablen ausweisen. |
| * ''infoValues'' -- Antwortcodes der Variablen ausweisen. |
| * ''infoQuestionText'' -- Fragetexte zu allen Variablen ausweisen. |
| |
Wenn der API-Link z.B. lautet: | Wenn der API-Link z.B. lautet: |
| |
https://www.soscisurvey.de/PROJEKT/?act=uDywDXaYyNEY&vList=STARTED,AB01,AB02,AB03_01&changed=2018-08-01T12:00:00 | https://www.soscisurvey.de/PROJEKT/?act=uDywDXaYyNEY&vList=STARTED,AB01,AB02,AB03_01&changed=2018-08-01T12:00:00 |
| |
| Zum Abruf der Variablen-Labels und Antwortcodes ohne weitere Daten diest der folgende Aufruf: |
| |
| https://www.soscisurvey.de/PROJEKT/?act=uDywDXaYyNEY&cases=none&infoValues |
| |
| |