CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Verbos
4. Exemplo de Chamada da API
5. Atributos de Resposta
6. Exemplos de JSON de Resposta

01. VISÃO GERAL

A API referenceValues tem como objetivo retornar a tabela de valores de referência para apoio de análise de eventos em auditoria quando utilizado a Carol Pós.

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:

1. Configuração do REST do Protheus

Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> +  /totvsHealthPlans/v1/referenceValues Exemplo:

Logo, a minha URL será: http://localhost:8080/rest/totvsHealthPlans/v1/referenceValues

03. VERBOS

Seguem os verbos disponíveis na API:

04. EXEMPLO DE CHAMADA DA API

VERBO GET

Através do verbo GET podemos retornar os dados da tabela de referência em 3 níveis:

NÍVEL 1

Retorna: Dados da Rede de Atendimento e Grupo de Internação

QueryParams obrigatórios: Não há.

URL Exemplo: http://localhost:8080/rest/totvshealthplans/v1/referenceValues?level=1

NÍVEL 2

Retorna: Categoria do Hospital, Regime Hospitalar e Acomodação.

QueryParams obrigatórios: healthProviderId (Código RDA) e hospitalizationGroupId (Código Grupo de Internação)

URL Exemplo: http://localhost:8080/rest/totvshealthplans/v1/referenceValues?level=1&healthProviderId=000004&hospitalizationGroupId=1

NÍVEL 3

Retorna: Todos os campos de consulta (quantidades e valores)

QueryParams obrigatórios: hospitalCategoryId (Código Categoria Hospitalar), accommodationId (Código Acomodação) e hospitalRegimeId (Código Regime Hospitalar)

URL Exemplo: http://localhost:8080/rest/totvshealthplans/v1/referenceValues?level=3&healthProviderId=000004&hospitalizationGroupId=1&hospitalCategoryId=1&accommodationId=1&hospitalRegimeId=1

05. TABELAS UTILIZADAS

Coloque o link das tabelas relacionadas