Notificações
Avisos da pessoa e suas preferências por tipo.
Lista as notificações da pessoa
GET /me/notificacoes
Acesso: Qualquer pessoa autenticada. Status de sucesso: 200.
Parâmetros de consulta
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
cursor | string | não | a 200 caracteres; ^[A-Za-z0-9_-]+$ | Cursor devolvido pela página anterior. |
limite | integer | não | 1…50; padrão: 20 | Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50). |
naoLidas | "0" | "1" | não | true devolve só as não lidas. |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
items | lista de NotificacaoDto | sim | ||
proximo | string ou nulo | sim | ||
naoLidas | integer | sim | 0… |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X GET "$API/me/notificacoes" -H "Authorization: Bearer $TOKEN"Quantas notificações não foram lidas
GET /me/notificacoes/contador
Acesso: Qualquer pessoa autenticada. Status de sucesso: 200.
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
naoLidas | integer | sim | 0… |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X GET "$API/me/notificacoes/contador" -H "Authorization: Bearer $TOKEN"Marca notificações como lidas
POST /me/notificacoes/lidas
Acesso: Qualquer pessoa autenticada. Limite: até 60 chamadas a cada 60 s por origem. Status de sucesso: 200.
Corpo da requisição (MarcarLidas)
Opção 1
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
ids | lista de string (uuid) | sim | 1–100 itens |
Opção 2
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
todas | true | sim |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
naoLidas | integer | sim | 0… |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X POST "$API/me/notificacoes/lidas" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"ids":["0198a000-0000-7000-8000-000000000001"]}'Lê as preferências de notificação
GET /me/notificacoes/preferencias
Acesso: Qualquer pessoa autenticada. Status de sucesso: 200.
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
items | lista de Preferencia | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X GET "$API/me/notificacoes/preferencias" -H "Authorization: Bearer $TOKEN"Atualiza as preferências de notificação
PUT /me/notificacoes/preferencias
Acesso: Qualquer pessoa autenticada. Limite: até 30 chamadas a cada 60 s por origem. Status de sucesso: 200.
Corpo da requisição (PreferenciasAtualizar)
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
items | lista de Preferencia | sim | 1–7 itens |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
items | lista de Preferencia | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X PUT "$API/me/notificacoes/preferencias" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"items":[{"evento":null,"inApp":null,"push":null}]}'