| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| de:results:data-api [30.04.2021 10:14] – sophia.schauer | de:results:data-api [19.08.2023 11:08] (aktuell) – admin |
|---|
| "LASTPAGE": 2, | "LASTPAGE": 2, |
| "MAXPAGE": 2 | "MAXPAGE": 2 |
| | } |
| | }, |
| | "variables": { |
| | "CASE": { |
| | "label": "Interview-Nummer (fortlaufend)", |
| | "type": "METRIC", |
| | "input": "SYSTEM" |
| | }, |
| | "SERIAL": { |
| | "label": "Personenkennung oder Teilnahmecode (sofern verwendet)", |
| | "type": "TEXT", |
| | "input": "SYSTEM" |
| } | } |
| } | } |
| * ''vSkip'' -- einzelne Variablen ausschließen. | * ''vSkip'' -- einzelne Variablen ausschließen. |
| * ''vSkipTime'' -- Die Variablen Zur Verweildauer (TIME000) und zur letzten Datenübermittlung (LASTDATA) ausschließen. | * ''vSkipTime'' -- Die Variablen Zur Verweildauer (TIME000) und zur letzten Datenübermittlung (LASTDATA) ausschließen. |
| * ''vQuality'' -- [[:de:results:variables#qualitaetsindikatoren|Qualitätsindikatoren]] (MISSING, MISSREL, TIME_RSI, DEG_TIME) in den Datensatz aufnehmen.\\ **Warnung:** Einige Qualitätsindikatoren werden auf Basis des heruntergeladenen Datensatzes oder Teildatensatzes normiert. Dies kann zu verzerrten oder fehlenden Werten führen, wenn nur Teildatensätze abgerufen werden. | * ''vQuality'' -- [[:de:results:variables#qualitaetsindikatoren|Qualitätsindikatoren]] (MISSING, MISSREL, TIME_RSI) in den Datensatz aufnehmen.\\ **Warnung:** Einige Qualitätsindikatoren werden auf Basis des heruntergeladenen Datensatzes oder Teildatensatzes normiert. Dies kann zu verzerrten oder fehlenden Werten führen, wenn nur Teildatensätze abgerufen werden. |
| * ''vAddress'' -- Kontaktdaten von Serienmail-Addressaten (E-Mail, Mobilnummer, UID) in den Datensatz aufnehmen (nur möglich, wenn die Adresseinträge mit dem [[:de:survey:mailing#datenschutz-modus|Datenschutz-Modus]] "personenbezogen" importiert wurde). | * ''vAddress'' -- Kontaktdaten von Serienmail-Addressaten (E-Mail, Mobilnummer, UID) in den Datensatz aufnehmen (nur möglich, wenn die Adresseinträge mit dem [[:de:survey:mailing#datenschutz-modus|Datenschutz-Modus]] "personenbezogen" importiert wurde). |
| * ''startMin'' -- Nur Fälle ab diesem Zeitpunkt abrufen. | * ''startMin'' -- Nur Fälle ab diesem Zeitpunkt abrufen. |
| * Der Zeitpunkt kann als Datum (YYYY-MM-DD) oder als Datum und Zeit (YYYY-MM-DD SS:MM:SS) angegeben werden, z.B. ''2018-04-01T16:30:30'' (das "T" zwischen Datum und Zeit ist optional, es ist auch ein Leerzeichen möglich). | * Der Zeitpunkt kann als Datum (YYYY-MM-DD) oder als Datum und Zeit (YYYY-MM-DD SS:MM:SS) angegeben werden, z.B. ''2018-04-01T16:30:30'' (das "T" zwischen Datum und Zeit ist optional, es ist auch ein Leerzeichen möglich). |
| * ''startMax'' -- Nur Fälle, die bis zu diesem Zeitpunkt begonnen wurden abrufen. | * ''startMax'' -- Nur Fälle, die bis zu diesem Zeitpunkt begonnen wurden abrufen. |
| * ''changed'' -- Nur Fälle abrufen, die zuletzt nach diesem Zeitpunkt geändert wurden. | * ''changedMin'' -- 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 ''changedMin'' (oder ''changed'') angibt, erhält man alle seit dem letzten Abruf geänderten Fälle. |
| | * ''changedMax'' -- Nur Fälle abrufen, die zuletzt vor diesem Zeitpunkt geändert wurden. **Hinweis:** Wenn keine Uhrzeit angegeben wird, wird 0:00 Uhr angenommen. Die Angabe ''2022-01-01'' lässt nur Fälle zu, bei denen ''LASTDATA'' vor dem 01. Januar 2022 liegt. Eine Uhrzeit kann durch Leerzeichen oder ''T'' getrennt angegeben werden, z.B. ''2021-12-31T23:59:59''. |
| * ''infoVariables'' -- Daten- und Abfrageformat von Variablen ausweisen. | * ''infoVariables'' -- Daten- und Abfrageformat von Variablen ausweisen. |
| * ''infoValues'' -- Antwortcodes der Variablen ausweisen. | * ''infoValues'' -- Antwortcodes der Variablen ausweisen. |
| * ''missing'' -- Umgang mit fehlenden Werten, erlaubt sind "code" (numerischer Code, Standard), "stata" (Stata-Codes) und "remove" (Fehlende Werte aus der Tabelle entfernen). | * ''missing'' -- Umgang mit fehlenden Werten, erlaubt sind "code" (numerischer Code, Standard), "stata" (Stata-Codes) und "remove" (Fehlende Werte aus der Tabelle entfernen). |
| * ''encoding'' -- Dateikodierung, erlaubt sind "utf-16" (UTF-16 LE für Excel, Standard), "utf-8" und "iso-8859-1". | * ''encoding'' -- Dateikodierung, erlaubt sind "utf-16" (UTF-16 LE für Excel, Standard), "utf-8" und "iso-8859-1". |
| | * ''values'' -- Kodierung der Antworten, erlaubt sind "codes" (numerische Codes, Standard) und "labels" (Texte der Auswahloptionen). |
| |
| |
| |
| **Hinweis:** Die Druckansicht unterliegt denselben Einschränkungen wie beim Aufruf über **Erhobene Daten** -> **Daten ansehen** -> Druckersymbol. Unter anderem wird in Fragen mit rotierten Items in abgeschlossenen Interviews eine andere (zufällige) Reihenfolge der Items verwendet als im Interview. | **Hinweis:** Die Druckansicht unterliegt denselben Einschränkungen wie beim Aufruf über **Erhobene Daten** -> **Daten ansehen** -> Druckersymbol. Unter anderem wird in Fragen mit rotierten Items in abgeschlossenen Interviews eine andere (zufällige) Reihenfolge der Items verwendet als im Interview. |
| | |
| | |
| | |
| | ===== Download hochgeladener Dateien ===== |
| | |
| | Falls über den API-Link Dateien abgerufen werden sollen, kann neben der Fallnummer (''case'') der Parameter ''prefix'' verwendet werden, um die gewünschte Datei zu spezifizieren. |
| | |
| | Falls kein Fall (''case'') angegeben wird, zeigt der API-Link eine Eingabefeld zur Eingabe der Fallnummer. |
| | |
| | Falls für einen Fall mehrere Dateien vorliegen, werden diese zur Auswahl angeboten. |
| |
| |
| |
| Die Meta-Information ''count'' bezieht sich auf die Anzahl passender Datensätze. Gesucht wird ausschließlich in den Datensätzen, welche die Kriterien erfüllen, die beim Anlegen des API-Links festgelegt wurden. | Die Meta-Information ''count'' bezieht sich auf die Anzahl passender Datensätze. Gesucht wird ausschließlich in den Datensätzen, welche die Kriterien erfüllen, die beim Anlegen des API-Links festgelegt wurden. |
| | |
| | |
| | ===== Referenz ===== |
| | |
| | ==== JSON ==== |
| | |
| | Die Variablen im JSON-Download beinhalten neben einer Beschreibung ("label") die Parameter "type" und "input". Folgende Werte sind dafür möglich. |
| | |
| | * ''type'' -- Variablentyp/Wertebereich der Variable |
| | * ''%%'BOOL'%%'' -- ein boolscher Wert (''true''/''false'') |
| | * ''%%'DICHOTOMOUS'%%'' -- ein dichotomer Wert (1/2) |
| | * ''%%'NOMINAL'%%'' -- ein numerischer Wert mit nominaler Kodierung |
| | * ''%%'ORDINAL'%%'' -- ein numerischer Wert mit ordinaler Kodierung |
| | * ''%%'METRIC'%%'' -- ein numerischer Wert mit metrischer Kodierung (Ganzzahl oder Dezimalzahl) |
| | * ''%%'TEXT'%%'' -- ein String (Code oder Freitext mit bis zu 64k Zeichen Länge) |
| | * ''%%'TIME'%%'' -- eine Datums- und Zeitangabe (''YYYY-MM-DD hh:mm:ss'') |
| | * ''%%'DATE'%%'' -- eine Datumsangabe (''YYYY-MM-DD'') |
| | * ''input'' -- Zur Datenerhebung verwendetes Eingabeformat |
| | * ''%%'OPEN'%%'' -- Offenes (Text-)Eingabefeld |
| | * ''%%'CHECKBOX'%%'' -- Auswahlfeld ein/aus (Checkbox oder andere Visualisierung) |
| | * ''%%'SELECTION'%%'' -- Auswahl zwischen unterschiedlichen Optionen (Radio Button oder andere Visualisierung) |
| | * ''%%'SCALE'%%'' -- Auswahl zwischen ordinal geordneten Optionen |
| | * ''%%'RANKING'%%'' -- Einsortieren der Option gegenüber anderen Optionen |
| | * ''%%'MEASURED'%%'' -- Nicht-explizit durch die Befragten angegebene Daten, z.B. Reaktionszeiten |
| | * ''%%'SYSTEM'%%'' -- Metadaten und andere Informationen, die systemseitig erhoben/verwaltet werden |
| | * ''%%'UNDEFINED'%%'' -- Das Eingabeformat für die Variable ist fehlerhaft oder nicht dokumentiert. |
| | |
| | **Hinweis:** Wenn der Typ einer Frage und damit der Typ einer Variable während der Erhebung geändert wird (z.B. von einem offenen Eingabefeld zu einem Skalenitem), dann können in den Daten auch andere Werte vorliegen als in der Variablenliste spezifiziert. |
