Skip to content

Rewinds

Mathis Lamidey edited this page Apr 23, 2025 · 2 revisions

Principe

Une aggrégation de statistiques dans une période donnée (pour l'instant fixé à une année) pour donner à tous les utilisateurs un récapitulatif de ses constributions et ses résultats sur cette période.

Module des rewinds

  • La base de donnée contient la liste des documents rewinds classés par utilisateur et par période.
  • Ces documents doivent être uploadés et générés via MARS.
  • Pour l'instant nous avons choisi de ne pas restrindre l'accès aux documents d'un utilisateur à l'autre, mais cela pourrait changer.

Interface

interface RwdBaseStats {
  // TODO
}

interface RwdTeam {
  // TODO
}

interface RwdMetadata {
  // TODO
}

interface Rewind {
  baseStats: RwdBaseStats,
  teamSongs: RwdTeam,
  teamVotes: RwdTeam,
  metadata: RwdMetadata,
}

Requêtes WS

Event Request parameters Response Subscribe Response Description
RWD-get
  • uid: string
  • year: number
  • rewindUpdate: Rewind
Récupère le rewind de l'utilisateur demandé, pour l'année demandée
RWD-unsubscribe
  • uid: string
  • year: number
Supprime les mises à jours du rewind de l'utilisateur demandé pour l'année demandée.

Clone this wiki locally