API-Endpoints

verwendete Endpunkte

  • alles was aus dem HumHub REST Modul kommt wird über v1 angesprochen
  • alles was aus dem Smart Village App Modul kommt wird über v2 angesprochen

Der Code für die API-Queries ist auf GitHub zu finden unter https://github.com/smart-village-solutions/smart-village-app-app/tree/master/src/queries/volunteer oder openCode unter https://gitlab.opencode.de/bad-belzig/smart-village-app/-/tree/master/src/queries/volunteer.

Authentifizierung (auth)

  • Login: POST /v1/auth/login
  • Registrierung: POST /v2/auth/register
  • Abschluss der Registrierung mit Code: POST /v2/auth/signup
  • eigenes Profil: GET /v1/auth/current

Kalender (calendar)

  • alle Kalendereinträge: GET /v2/calendar
  • alle Kalendereinträge in einer Gruppe: GET /v2/calendar/container/${id}
  • ein Kalendereintrag: GET /v2/calendar/entry/${id}
  • Teilnahme an einem Kalendereintrag: POST /v1/calendar/entry/${id}/respond
  • einen Kalendereintrag anlegen: POST /v1/calendar/entry/${id}
  • einen Kalendereintrag bearbeiten: PUT /v1/calendar/entry/${id}
  • einen Kalendereintrag löschen: DELETE /v1/calendar/entry/${id}
  • eine Datei zu einem Kalendereintrag hochladen: POST /v1/calendar/entry/${id}/upload-files
  • eine Datei aus einem Kalendereintrag entfernen: DELETE /v1/calendar/entry/${id}/remove-files/${fileId}

Unterhaltungen (conversation)

  • alle Unterhaltungen: GET /v2/mail
  • alle Nachrichten einer Unterhaltung: GET /v2/mail/${id}/entries
  • alle Teilnehmer einer Unterhaltung: GET /v1/mail/${id}/users
  • eine Unterhaltung anlegen: POST /v1/mail
  • eine Nachricht in einer Unterhaltung anlegen: POST /v1/mail/${id}/entry
  • eine Datei zu einer Nachricht hochladen: POST /v2/mail/${id}/upload-files

Gruppen (group)

  • alle Gruppen: GET /v2/space
  • alle Gruppen bei denen ein User Mitglied ist: GET /v2/space/memberships
  • eine Gruppe: GET /v2/space/${id}
  • eine Gruppe anlegen: POST /v1/space
  • eine Gruppe bearbeiten: PUT /v1/space/${id}
  • eine Gruppe löschen: DELETE /v1/space/${id}
  • alle Mitglieder einer Gruppe: GET /v2/space/${id}/membership
  • eine Gruppe beitreten: POST /v2/space/${id}/membership/${userId}
  • Beitrittsanfrage an eine Gruppe: POST /v2/space/${id}/membership/${userId}/request
  • eine Gruppe verlassen: DELETE /v2/space/${id}/membership/${userId}

Beiträge (post)

  • alle Beiträge in einer Gruppe: GET /v1/post/container/${id}
  • ein Beitrag: GET /v1/post/${id}
  • einen Beitrag in einer Gruppe anlegen: POST /v1/post/container/${id}
  • einen Beitrag bearbeiten: PUT /v1/post/${id}
  • einen Beitrag löschen: DELETE /v1/post/${id}
  • eine Datei zu einem Beitrag hochladen: POST /v1/post/${id}/upload-files

Uploads (upload)

  • eine Datei löschen: DELETE /v2/file/${id}

User (user)

  • alle User: GET /v2/user
  • ein User: GET /v2/user/${id}
  • einen User bearbeiten: PUT /v1/user/${id}
  • Gruppen eines Users: GET /v2/user/group
  • Benachrichtigungseinstellungen eines Users: GET /v2/user/notification-settings
  • Benachrichtigungseinstellungen eines Users aktualisieren: POST /v2/user/notification-settings

Push-Benachrichtigungen (push)

  • Push-Token ablegen: PUT /v2/sva_push/token/${token}
  • Push-Token löschen: DELETE /v2/sva_push/token/${token}