| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende ÜberarbeitungNächste ÜberarbeitungBeide Seiten der Revision |
| de:results:data-api [29.04.2019 16:05] – admin | de:results:data-api [06.11.2020 22:33] – Neuer Parameter SERIAL admin |
|---|
| * **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. | * Die Angabe des Parameters ''none'' deaktiviert den Abruf von Daten, wenn z.B. nur die Variablen und/oder Antwortcodes abgerufen werden sollen. |
| | * ''SERIAL'' -- Einschränkung auf Fälle mit dieser/n Personenkennung/en |
| | * Es können mehrere SERIALs durch komma getrennt spezifiziert werden, z.B. ''ABCD12,BCDE23'' |
| | * Falls sowohl ''cases'' als auch ''SERIAL'' spezifiziert werden, werden nur Fälle abgerufen, welche beide Kriterien zugleich erfüllen (Schnittmenge). |
| * ''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. |
| |
| **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. |
| | |
| | |
| | ===== Datensätze nach Personencode (SERIAL) ===== |
| | |
| | Ein API-Link zum Auflisten von Datensätzen nach Personencode muss beim Aufruf um einen Parameter ''SERIAL'' ergänzt werden, z.B. |
| | |
| | https://www.soscisurvey.de/project/?act=sIyhrICdaBxl6qiMagedOU1K&SERIAL=ABC12345 |
| | |
| | Zurückgegeben wird ein Objekt in JSON-Notation, welches neben dem Abfragstatus (''result'') und einigen Meta-Daten (''meta'') ein Array enthält, welche Datensätze mit dieser Personenkennung (SERIAL) im Datensatz vorliegen. |
| | |
| | <code javascript> |
| | { |
| | "result":"ok", |
| | "meta":{ |
| | "project":"project", |
| | "datetime":"2020-07-14 16:03:00", |
| | "count":1 |
| | }, |
| | "cases":[ |
| | { |
| | "CASE":"145", |
| | "SERIAL":"ABC12345", |
| | "FINISHED":true |
| | } |
| | ] |
| | } |
| | </code> |
| | |
| | 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. |
