Notificaciones
Avisos de la persona y sus preferencias por tipo.
Lista las notificaciones de la persona
GET /me/notificacoes
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
cursor | string | no | a 200 caracteres; ^[A-Za-z0-9_-]+$ | Cursor devuelto por la página anterior. |
limite | integer | no | 1…50; por defecto: 20 | Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50). |
naoLidas | "0" | "1" | no | true devuelve solo las no leídas. |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de NotificacaoDto | sí | ||
proximo | string o nulo | sí | ||
naoLidas | integer | sí | 0… |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/me/notificacoes" -H "Authorization: Bearer $TOKEN"Cuántas notificaciones no se han leído
GET /me/notificacoes/contador
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
naoLidas | integer | sí | 0… |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/me/notificacoes/contador" -H "Authorization: Bearer $TOKEN"Marca notificaciones como leídas
POST /me/notificacoes/lidas
Acceso: Cualquier persona autenticada. Límite: hasta 60 llamadas cada 60 s por origen. Estado de éxito: 200.
Cuerpo de la solicitud (MarcarLidas)
Opción 1
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
ids | lista de string (uuid) | sí | 1–100 elementos |
Opción 2
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
todas | true | sí |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
naoLidas | integer | sí | 0… |
En caso de error: modelo ErroApi.
Ejemplo
curl -X POST "$API/me/notificacoes/lidas" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"ids":["0198a000-0000-7000-8000-000000000001"]}'Lee las preferencias de notificación
GET /me/notificacoes/preferencias
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de Preferencia | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/me/notificacoes/preferencias" -H "Authorization: Bearer $TOKEN"Actualiza las preferencias de notificación
PUT /me/notificacoes/preferencias
Acceso: Cualquier persona autenticada. Límite: hasta 30 llamadas cada 60 s por origen. Estado de éxito: 200.
Cuerpo de la solicitud (PreferenciasAtualizar)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de Preferencia | sí | 1–7 elementos |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de Preferencia | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X PUT "$API/me/notificacoes/preferencias" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"items":[{"evento":null,"inApp":null,"push":null}]}'