API Notification

CONTEÚDO

Visão Geral
Configurações INI
Verbos
Uso da API - POST
Atributos de Resposta
Tabelas utilizadas

01. VISÃO GERAL

A API notification tem como objetivo retornar notícias cadastradas para beneficiários e também incluir o histórico de visualização. Os verbos disponibilizados são o GET e o POST.

02. CONFIGURAÇÕES INI

Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo	URL	Descrição
GET	https://<url>:porta>/rest/totvsHealthPlans/v1/notification	Retorna as notícias para o beneficiário informado e quais foram já foram visualizadas ou não visualizadas.
POST	https://<url>:porta>/rest/totvsHealthPlans/v1/notification	Registra o histórico de visualizações da notícia.

04. USO DA API

GET

Dados do queryparam de envio:

Atributo	Tipo	Regra	Descrição
codeUser	Caracter	Obrigatório	BSW_CODUSR

POST

Dados do body de envio:

Atributo	Tipo	Regra	Descrição
codeNotification	Caracter	Obrigatório	BPL_CODIGO
codeUser	Caracter	Obrigatório	BSW_CODUSR

05. ATRIBUTOS DE RESPOSTA

API GET - JSON de resposta:

Atributo	Campo Protheus
code	BPL_CODIGO
title	BPL_TITULO
message	BPL_NOTICI
visualized	Se tiver registro para BPL_CODIGO + BSW_CODUSR na tabela BJH será enviado true, caso contrário, false.

API POST - JSON de resposta:

06. TABELAS UTILIZADAS

BSW - Login

BPL - Cadastro de Noticias

BJH - Notificações Lidas

Árvore de páginas