V1::NotificationsController

Notifications

index

View list of all students notifications or collaborators notifications

URL

GET /students/:student_id/notifications or /collaborators/:collaborator_id/notifications

Response Fields

Nome Tipo Descrição
notifications Array<Notification>

List of notifications

show

View a notification

URL

GET /notification/:id

Parâmetros obrigatórios

Nome Tipo Descrição
id Integer

Identifier the notification

Objeto resposta

Notification

The requested notification

create

Create notification

URL

POST /students/:student_id/notifications or /collaborators/:collaborator_id/notifications

Parâmetros obrigatórios

Nome Tipo Descrição
notification Hash

The notification to create

Parâmetros opcionais

Nome Tipo Descrição
notification[text] String

Text of the notification

notification[url] String

Url of the notification

toggle_read

Change notification read

URL

PUT/PATCH /notifications/:id/toggle_read

Parâmetros obrigatórios

Nome Tipo Descrição
id Integer

Id of an notification