JSON:API: Zugriff auf Abos

[PhilippPBS]

Sowohl die PBS Geschäftsstelle wie auch Kantonalverbände und Pfadiabteilungen nutzen Abos, um individuelle Versandgruppen zusammenzustellen und auf die jeweils aktuellsten Adressdaten zugreifen zu können.

Damit diese Abos auch mit externen Tools (z.B. Newsletter-Tools) genutzt werden können, ist eine Erweiterung der JSON:API notwendig. Aktuell ist eine automatische Synchronisierung solcher Listen nur über die integrierte MailChimp-Funktion möglich, was uns auf ein einzelnes Tool beschränkt.

Die ältere REST-API bot die Möglichkeit, Informationen über Abos und deren Abonnent*innen abzurufen. Umso wichtiger wäre es für uns, diese Funktionalität auch in die neue API zu übernehmen.

Mockup

Die JSON:API der MiData wird um folgende Endpunkte ergänzt (Vorschlag, Liste kann gerne diskutiert und abgeändert werden):

Informationen abfragen: (ähnlich einer Gruppe)

• GET /api/mailing_lists: Darstellung sämtlicher Abos
• GET /api/mailing_lists/{ID}: Abfragen von Informationen und Abonent*innen einer Gruppe
• etc.

Informationen ändern: (sekundär, ermöglicht gegenseitige Synchronisierung)

• PUT /api/mailing_lists/{ID}: Neue Abonnent*innen hinzufügen (z.B. mit Input-Array aller Personen-IDs)
• DELETE /api/mailing_lists/{ID}: Neue Abonnent*innen löschen (z.B. mit Input-Array aller Personen-IDs).
• etc.

Tech-Spec

ToDo