CONTEÚDO
- Visão Geral
- Configurações INI
- Verbos
- Uso da API - POST
- Atributos de Resposta
- Tabelas utilizadas
01. VISÃO GERAL
A API protocols tem como objetivo retornar os dados de protocolos/pegs(BCI) do prestador informado. O verbo disponibilizado é o GET.
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/protocols | Retorna os protocolos do prestador. |
04. USO DA API - GET
Dados do queryparam de envio:
Atributo | Tipo | Descrição |
|---|---|---|
| healthProvider | Caracter | Código da RDA(BCI_CODRDA) |
| year | Caracter | Ano(BCI_ANO) |
| mounth | Caracter | Mês(BCI_MES) |
| page | Caracter | (Opcional) Controle de número de paginas da aplicação |
| pageSize | Caracter | (Opcional) Controle de quantidade de itens que serão retornados. |
05. ATRIBUTOS DE RESPOSTA
JSON de resposta.
Atributo | Campo Protheus |
|---|---|
| protocol | BCI_CODPEG |
| batchNumber | BCI_LOTGUI |
| providerNumber | BCI_IDXML |
| status | BCI_STTISS |
| givenValue | BD7_VALORI |
| glossValue | BD7_VLRGLO + BD7_VLRGTX |
| value | BD7_VLRPAG |
| mounth | BCI_MES |
| year | BCI_ANO |
06. TABELAS UTILIZADAS
BCI - Protocolos
BD7 - Composição eventos
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas