get_docs_by_group

Funktion

Liefert alle oder einzelne öffentliche Dokumentegruppen inklusive Angaben zu den darin enthaltenen öffentlichen Dokumenten aus Verowa zurück, damit diese im Frontend einer Webseite aufgelistet werden können.

Aus Performancegründen enthält diese Methode nicht den eigentlichen Dateiinhalt. Dieser wird bei Bedarf einzeln via get_doc_by_id Base64-codiert abgeholt.

Resource URL

https://api.verowa.ch/get_docs_by_group/:instance/:apikey/:group-ids/

Parameter

• Ihr Instanzname :instance
• Ihr API-Key :apikey
• Dokumentegruppen-IDs :group-ids (mehrere Gruppen können mit Kommata getrennt werden z.B. 4,21); 0 = alle Gruppen

Beispiele

Gruppen-Infos und Dokumente aller öffentlicher Gruppen:

GET https://api.verowa.ch/get_docs_by_group/demo/8209042b1786e26c355d4aea1b8c7b79/0

Gruppen-Infos und Dokumente der Gruppen 1 und 24:

GET https://api.verowa.ch/get_docs_by_group/demo/8209042b1786e26c355d4aea1b8c7b79/1,24

Die API gibt nur öffentliche Gruppen und darin enthaltene öffentliche Dokumente aus.

Server-Antwort (Muster)

[
	{
		"group_id": 1, [i]
immer eine Ganzzahl

		"name": "Ausgaben Pfarreiblatt", [i]
der öffentliche Name der Dokumentegruppe

		"description": "", [i]
eine kurze Beschreibung der Dokumentegruppe

		"documents": {
			0: { 
				"doc_id": 28, [i]
immer eine Ganzzahl; Sie benötigen diese ID für get_doc_by_id, um den Dateiinhalt vom Server zu laden

				"title": "Pfarreiblatt 16/2025",
				"filename": "Pfarreiblatt_2025-15.pdf", [i]
der Original-Dateiname

				"size_kb": 4038, [i]
Dateigrösse in Kilobytes; immer eine Ganzzahl

				"description": "", [i]
eine kurze Beschreibung des Dokuments, ohne HTML-Elemente
 
				"last_mod": "2025-08-13 08:33:04",  [i]
Datum + Zeit der letzten Änderung des Eintrags, nicht der Datei selber; wenn z.B. nur der Titel angepasst wurde, wird last_mod trotzdem angepasst, auch wenn die Datei selber unverändert blieb
 
				"position": 1, [i]
die in Verowa vorgesehene Reihenfolge innerhalb der Dokumentegruppe
 
			}
		}
	}
]

Zurück