iGRPIGRP 3.0Documentation

Inbox

Notificações IN_APP do utilizador autenticado.

Listar a inbox

GET
/api/v1/inbox

Permissão: igrp.notification.inbox. Token do utilizador: o userId sai do token. Filtros unreadOnly e includeArchived; página de 20 por omissão.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de query

unreadOnly?boolean
Predefinidofalse
includeArchived?boolean
Predefinidofalse
pageable*

Corpo da resposta

OK

*/*
  1. response
content?array<>
page?integer
Formatoint32
size?integer
Formatoint32
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/inbox?page=0&size=1&sort=string'
{  "content": [    {      "deliveryId": "73dc828d-801d-4d29-b7e4-e046662a5901",      "subject": "string",      "title": "string",      "body": "string",      "category": "string",      "businessKey": "string",      "status": "string",      "read": true,      "archived": true,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "page": 0,  "size": 0,  "totalElements": 0,  "totalPages": 0}

Contar não lidas

GET
/api/v1/inbox/unread-count

Permissão: igrp.notification.inbox. Token do utilizador: o userId sai do token.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Corpo da resposta

OK

*/*
  1. response
[key: string]?integer
Formatoint64
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/inbox/unread-count'
{  "property1": 0,  "property2": 0}

Marcar como lida

POST
/api/v1/inbox/{deliveryId}/read

Permissão: igrp.notification.inbox. Token do utilizador: o userId sai do token.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

deliveryId*string
Formatouuid

Corpo da resposta

OK

curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/inbox/497f6eca-6276-4993-bfeb-53cbbbba6f08/read'
Vazio

Marcar todas como lidas

POST
/api/v1/inbox/read

Permissão: igrp.notification.inbox. Token do utilizador: o userId sai do token.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Corpo da resposta

OK

curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/inbox/read'
Vazio

Arquivar

POST
/api/v1/inbox/{deliveryId}/archive

Permissão: igrp.notification.inbox. Token do utilizador: o userId sai do token.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

deliveryId*string
Formatouuid

Corpo da resposta

OK

curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/inbox/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive'
Vazio
How is this guide?

Última atualização: