API referenceValues

CONTEÚDO

Visão Geral
Configurações INI
Verbos
Exemplo de Chamada da API
Atributos de Resposta
Tabelas Utilizadas

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:

Verbo	Path	Query Params	Descrição
GET	referenceValues	level healthProviderId healthProviderOfficialRecord healthProviderName hospitalizationGroupId hospitalCategoryId accommodationId hospitalRegimeId	Retorna dados da tabela de referência

04. EXEMPLO DE CHAMADA DA API

VERBO GET

Através do verbo GET podemos retornar os dados da tabela de referência em 2 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

No nível 1 ainda podemos realizar alguns filtros opcionais:

Atributo	Descrição
healthProviderId	Código RDA
healthProviderOfficialRecord	CPF/CNPJ RDA
healthProviderName	Descrição RDA
hospitalizationGroupId	Código Grupo de Internação
hospitalCategoryId	Código Categoria Hospitalar
accommodationId	Código Acomodação
hospitalRegimeId	Código Regime Hospitalar

NÍVEL 2

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

QueryParams obrigatórios:

Atributo	Descrição
healthProviderId	Código RDA
hospitalizationGroupId	Código Grupo de Internação
hospitalCategoryId	Código Categoria Hospitalar
accommodationId	Código Acomodação
hospitalRegimeId	Código Regime Hospitalar

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

05. ATRIBUTOS DE RESPOSTA

Chamada GET Level 1:

Atributo	Campo Protheus	Tipo
healthProviderId	BO0_CODRDA	Caracter
hospitalizationGroupId	BO0_GRPINT	Caracter
officialRecord	BAU_CPFCGC	Caracter
name	BAU_NOME	Caracter
hospitalCategoryId	BO0_CATHOS	Caracter
accommodationId	BO0_ACOMOD	Caracter
hospitalRegimeId	BO0_REGINT	Caracter

Sucesso 200 - Level 1

{
    "hasNext": false,
    "items": [
        {
            "healthInsurer": {
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "name": "HOSPITAL BOM CLIMA"
            },
            "hospitalizationGroup": {
                "id": "1",
                "description": "Clinica"
            },
            "hospitalCategory": {
                "id": "1",
                "description": "AAA - Alto custo"
            },
            "hospitalRegime": {
                "id": "1",
                "description": "Hospitalar"
            },
            "accommodation": {
                "id": "1",
                "description": "Enfermaria"
            }
        },
        {
            "healthInsurer": {
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "name": "HOSPITAL BOM CLIMA"
            },
            "hospitalizationGroup": {
                "id": "1",
                "description": "Clinica"
            },
            "hospitalCategory": {
                "id": "1",
                "description": "AAA - Alto custo"
            },
            "hospitalRegime": {
                "id": "3",
                "description": "Domiciliar"
            },
            "accommodation": {
                "id": "1",
                "description": "Enfermaria"
            }
        },
        {
            "healthInsurer": {
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "name": "HOSPITAL BOM CLIMA"
            },
            "hospitalizationGroup": {
                "id": "1",
                "description": "Clinica"
            },
            "hospitalCategory": {
                "id": "2",
                "description": "AA - Custo Medio"
            },
            "hospitalRegime": {
                "id": "1",
                "description": "Hospitalar"
            },
            "accommodation": {
                "id": "1",
                "description": "Enfermaria"
            }
        },
        {
            "healthInsurer": {
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "name": "HOSPITAL BOM CLIMA"
            },
            "hospitalizationGroup": {
                "id": "2",
                "description": "Cirurgica"
            },
            "hospitalCategory": {
                "id": "2",
                "description": "AA - Custo Medio"
            },
            "hospitalRegime": {
                "id": "2",
                "description": "Hospital-Dia"
            },
            "accommodation": {
                "id": "2",
                "description": "Apartamento"
            }
        },
        {
            "healthInsurer": {
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "name": "HOSPITAL BOM CLIMA"
            },
            "hospitalizationGroup": {
                "id": "3",
                "description": "Obstetrica"
            },
            "hospitalCategory": {
                "id": "3",
                "description": "A - Custo Padrao"
            },
            "hospitalRegime": {
                "id": "3",
                "description": "Domiciliar"
            },
            "accommodation": {
                "id": "3",
                "description": "UTI"
            }
        },
        {
            "healthInsurer": {
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "name": "HOSPITAL BOM CLIMA"
            },
            "hospitalizationGroup": {
                "id": "4",
                "description": "Pediatrica"
            },
            "hospitalCategory": {
                "id": "4",
                "description": "I - Interior"
            },
            "hospitalRegime": {
                "id": "1",
                "description": "Hospitalar"
            },
            "accommodation": {
                "id": "1",
                "description": "Enfermaria"
            }
        },
        {
            "healthInsurer": {
                "healthProviderId": "000004",
                "officialRecord": "34585221000190",
                "name": "HOSPITAL BOM CLIMA"
            },
            "hospitalizationGroup": {
                "id": "5",
                "description": "Psiquiatrica"
            },
            "hospitalCategory": {
                "id": "5",
                "description": "E - Especial"
            },
            "hospitalRegime": {
                "id": "2",
                "description": "Hospital-Dia"
            },
            "accommodation": {
                "id": "2",
                "description": "Apartamento"
            }
        },
        {
            "healthInsurer": {
                "healthProviderId": "000005",
                "officialRecord": "48564082000123",
                "name": "PRODE ODONTOLOGIA"
            },
            "hospitalizationGroup": {
                "id": "1",
                "description": "Clinica"
            },
            "hospitalCategory": {
                "id": "1",
                "description": "AAA - Alto custo"
            },
            "hospitalRegime": {
                "id": "1",
                "description": "Hospitalar"
            },
            "accommodation": {
                "id": "1",
                "description": "Enfermaria"
            }
        }
    ]
}

Chamada GET Level 2:

Atributo	Campo Protheus	Tipo
initialDate	BO0_DATINI	Data
finalDate	BO0_DATFIM	Data
frequence	BO0_FREQ	Numérico
CLDValue	BO0_CLD	Numérico
CMIValue	BO0_CMI	Numérico
hospitalizationAmount	BO0_QTDINT	Numérico
dailyGrouping	BO0_AGRDIA	Caracter

Sucesso 200 - Level 2

{
    "hasNext": false,
    "items": [
        {
            "initialDate": "2024-01-01",
            "finalDate": "2025-12-31",
            "dailyGrouping": "Agrupamento Diaria 1",
            "frequence": 2,
            "hospitalizationAmount": 5,
            "CLDValue": 60.66,
            "CMIValue": 77.42
        },
        {
            "initialDate": "",
            "finalDate": "",
            "dailyGrouping": "Agrupamento Diaria 2",
            "frequence": 3,
            "hospitalizationAmount": 3,
            "CLDValue": 100,
            "CMIValue": 150
        }
    ]
}

GET com falha 400:

Erro 400

{
    "code": 400,
    "message": "Campo obrigatorio nao informado",
    "detailedMessage": "level"
}

06. TABELAS UTILIZADAS

Tabelas SX2:

Chave	Aquivo	Nome	Modo	ModoUn	ModoEmp	Único
BO0	BO0T10	Valores de Referência	Compartilhado	Exclusivo	Exclusivo	BO0_FILIAL+BO0_SEQUEN

Campos SX3 (Tabela BO0):

Campo	Ordem	Tipo	Tamanho	Decimal	Título	Descrição	Picture	Valid	Browse	Visual	Contexto	Cbox
BO0_FILIAL	01	Caracter	8	0	Filial	Filial do Sistema	@!		Não	Alterar	Real
BO0_SEQUEN	02	Caracter	10	0	Sequencial	Sequencial	@!		Sim	Alterar	Real
BO0_CODINT	03	Caracter	4	0	Operadora	Código Operadora	@!		Sim	Alterar	Real
BO0_CODRDA	04	Caracter	6	0	Cod RDA	Código Rede Atendimento	@!		Sim	Alterar	Real
BO0_CATHOS	05	Caracter	1	0	Categ Hosp	Categoria Hospitalar	@!	Vazio .Or. Pertence('12345')	Sim	Alterar	Real	Vazio .Or. Pertence('12345')
BO0_ACOMOD	06	Caracter	1	0	Tipo de Acom	Tipo de Acomodação	@!	Vazio .Or. Pertence('123')	Sim	Alterar	Real	Vazio .Or. Pertence('123')
BO0_GRPINT	07	Caracter	1	0	Grupo Intern	Grupo de Internação	@!	Vazio .Or. Pertence('12345')	Sim	Alterar	Real	Vazio .Or. Pertence('12345')
BO0_REGINT	08	Caracter	1	0	Regime Inter	Regime de Internação	@!	Vazio .Or. Pertence('123')	Sim	Alterar	Real	Vazio .Or. Pertence('123')
BO0_DATINI	09	Date	8	0	Iní Periodo	Início Período			Sim	Alterar	Real
BO0_DATFIM	10	Date	8	0	Fim Período	Fim Período			Sim	Alterar	Real
BO0_AGRDIA	11	Caracter	20	0	Agrup Diaria	Agrup. de Diárias			Sim	Alterar	Real
BO0_FREQ	12	Number	12	0	Frequência	Frequência	@E 999999999999		Sim	Alterar	Real
BO0_QTDINT	13	Number	12	0	Qtd Intern	Qtd Internações	@E 999999999999		Sim	Alterar	Real
BO0_CLD	14	Number	17	2	Valor CLD	Valor CLD	@E 999,999,999.99		Sim	Alterar	Real
BO0_CMI	15	Number	17	2	Valor CMI	Valor CMI	@E 999,999,999.99		Sim	Alterar	Real

Índices SIX:

Índice	Chave	Chave
BO0	1	BO0_FILIAL+BO0_SEQUEN
BO0	2	BO0_FILIAL+BO0_CODINT+BO0_CODRDA+BO0_GRPINT+BO0_CATHOS+BO0_REGINT+BO0_ACOMOD

Árvore de páginas