esup-multi

Arborescence des pages

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

Bloc de code
<host>/<uri>/register
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

...

Bloc de code
{
  username: String, 
  token: String,   
  platform: String, 
  ip: String        
}
  • username : Login de l'utilisateur (obligatoire)
  • token token : Token FCM retourné par Firebase (obligatoire)
  • platform : Plateforme du périphérique (iOS, Android, Web, AmazonFire) (obligatoire)
  • ip : IP depuis laquelle le périphérique s'enregistre

...

Bloc de code
<host>/<uri>/unregister
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

...

Bloc de code
{
  username: String, 
  token: String     
}
  • username : Login de l'utilisateur (obligatoire)
  • token token : Token FCM retourné par Firebase (obligatoire)

...

Bloc de code
<host>/<uri>/notifications/<username>
<host>/<uri>/notifications/<username>?offset=0&length=10
  • host : adresse du serveur
  • uri : chemin éventuel vers le service
  • username : Login de l'utilisateur (obligatoire)
  • offset : offset de la prochaine notification à récupérer. Les notifications seront triées de la plus récente à la plus ancienne.
  • length : nombre de notifications à récupérer à partir de l’offset

...

Bloc de code
{
  id: String,             // id de la notif en base
  author: String,         // auteur de la notif (Nom prénom). Default = '@system'
  channel: String,        // canal de diffusion
  title: String,          // titre de la notification
  message: String,        // message de la notification
  state: String,          // état de la notification (READ, UNREAD)
  url: String,           // lien de la page externe vers laquelle rediriger le user
  creationDate: Datetime, // date de la notification
}
  • id : Id de la notification en base
  • author : Auteur de la notification (Nom  prénom). Par défaut @system
  • channel : Canal de diffusion
  • title : Titre de la notification
  • message : Message de la notification
  • state : État de la notification (READ, UNREAD)
  • url : Lien vers une page externe
  • creationDate : Date d'emission de la notification

...

Bloc de code
<host>/<uri>/notifications/read
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

...

Bloc de code
{
  username: String,           
  notificationId: [String]
}
  • username : Login de l'utilisateur (obligatoire)
  • notificationId : tableau des Id de notification à passer comme "lues"

...

Bloc de code
<host>/<uri>/notifications/unread
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

...

Bloc de code
{
  username: String,           
  notificationId: [String]
}
  • username : Login de l'utilisateur (obligatoire)
  • notificationId : tableau des Id de notification à passer comme "lues"

...

Bloc de code
<host>/<uri>/channels/{username}
  • host : adresse du serveur
  • uri : chemin éventuel vers le service
  • username : Login de l'utilisateur (obligatoire)

...

Bloc de code
{
  channels: [String]    
}
  • channels : Liste des canaux pour lesquels l'utilisateur s'est désabonné

...

Bloc de code
<host>/<uri>/channels
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

...

Bloc de code
{
  username: String,       
  channels: [String],      
}
  • username : Login de l'utilisateur (obligatoire)
  • channels : Liste des canaux pour lesquels l'utilisateur s'est désabonné

...

Bloc de code
<host>/<uri>/notifications
  • host : adresse du serveur
  • uri : chemin éventuel vers le service

...

Bloc de code
{
  username: String,           
  notificationId: String
}
  • username : Login de l'utilisateur (obligatoire)
  • notificationId : Id de la notification à supprimer (obligatoire)

...