Durch die Entwicklung des Frontends wurde klar, welche Routen für Anfragen an die API benötigt werden, und in welchem Format die entsprechenden Daten sein sollten. Diese werden im folgenden dokumentiert und bei Bedarf aktualisiert.
Guideline-Liste : Array
Objekteigenschaften pro Guideline:
id: Int
title: String
teaser: String
approvements: Array [
userId: Int
name: String
image: String (Base64 Image)
]
id: Int
name: String (Name des Nutzers, welcher die Annotation verfasst hat),
image: String (Base64 Image)
text: String
score: Int (Aktueller Voting-Score)
userVote: String? (Wie hat der Nutzer, welcher die Annotation anfragt bereits abgestimmt? Kann "u", "d" oder null sein)
Durch die Entwicklung des Frontends wurde klar, welche Routen für Anfragen an die API benötigt werden, und in welchem Format die entsprechenden Daten sein sollten. Diese werden im folgenden dokumentiert und bei Bedarf aktualisiert.
Guideline-Liste : Array
Objekteigenschaften pro Guideline: id: Int title: String teaser: String approvements: Array [ userId: Int name: String image: String (Base64 Image) ]
Nutzerprofil: Objekt
userId: Int, name: String isExpert: Boolean memberSince: Date bio: String qualification: String image: String (Base64 Image)
Annotation: Objekt
id: Int name: String (Name des Nutzers, welcher die Annotation verfasst hat), image: String (Base64 Image) text: String score: Int (Aktueller Voting-Score) userVote: String? (Wie hat der Nutzer, welcher die Annotation anfragt bereits abgestimmt? Kann "u", "d" oder null sein)