CONTEÚDO

  1. Visão Geral
  2. Configurações INI
  3. Verbos
  4. Corpo da Requisição
  5. Exemplos de Jsons de Resposta


01. VISÃO GERAL

A API dtaValidate tem como objetivo verificar se os eventos enviados no corpo da requisição (body) existem ou não na base de dados. 

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:

Configuração do REST Protheus

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

Exemplo:

Logo, a minha URL será: http://localhost:8080/rest/totvshealthplans/v1/dtaValidate

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo

Path

Descrição

POST/dtaValidateRetorna se eventos enviados no corpo da requisição existem ou não na base de dados

04. CORPO DA REQUISIÇÃO


Detalhes do corpo da requisição (body em formato JSON):



{
    "procedures": [
        {
            "procedureCode": "10101012",
            "procedureDescription": "CONSULTA EM CONSULTORIO"
        }
    ],
    "filter": "(tableCode eq '18' or tableCode eq '19' or tableCode eq '20' or  tableCode eq '22' or tableCode eq '00' or tableCode eq '98') and procedureId eq 'defaultValue'",
    "customWhere": "2"
}

Campo

Descrição

proceduresArray de procedimentos que serão verificados se existem na base
filter

Filtro que será realizado na API. O padrão do filtro é:

(Filtro de Tabelas) and filtro de Código de Procedimento, exemplo de como ficaria:

(tableCode eq '18' or tableCode eq '19' or tableCode eq '20' or  tableCode eq '22' or tableCode eq '00' or tableCode eq '98') and procedureId eq 'defaultValue'


Atenção para o valor comparado ao procedureId, deve sempre ser 'defaultValue'.

customWhere

Corresponde à jornada para a qual será realizada a verificação dos procedimentos.


Exemplo de chamada:


05. EXEMPLOS DE JSONS DE RESPOSTA

Sucesso 200



{
    "proceduresNotFound": [],
    "procedures": [
        {
            "tableCode": "22",
            "procedureCode": "40306429",
            "procedureDescription": "ANTIPARIETAL"
        },
        {
            "tableCode": "22",
            "procedureCode": "40308553",
            "procedureDescription": "ANTI TRANSGLUTAMINASE TECIDUAL - IGA"
        },
        {
            "tableCode": "18",
            "procedureCode": "40308553",
            "procedureDescription": "Anti transglutaminase tecidual - IgA"
        },
        {
            "tableCode": "22",
            "procedureCode": "40306305",
            "procedureDescription": "ANTICORPOS ANTI-GLIADINA - IGA"
        },
        {
            "tableCode": "22",
            "procedureCode": "40306321",
            "procedureDescription": "ANTICORPOS ANTI-GLIADINA - IGM"
        },
        {
            "tableCode": "22",
            "procedureCode": "40306313",
            "procedureDescription": "ANTIGLIADINA (GLÚTEN) - IGG"
        },
        {
            "tableCode": "22",
            "procedureCode": "40306259",
            "procedureDescription": "ANTICORPOS ANTIENDOMISIO - IGG IGM IGA (CADA) - PESQUISA E/OU DOSAGEM"
        },
        {
            "tableCode": "22",
            "procedureCode": "40312445",
            "procedureDescription": "TESTE RESPIRATÓRIO DE INTOLERÂNCIA À LACTOSE"
        },
        {
            "tableCode": "22",
            "procedureCode": "40316203",
            "procedureDescription": "CRESCIMENTO, HORMÔNIO DO (HGH)"
        },
        {
            "tableCode": "22",
            "procedureCode": "40316190",
            "procedureDescription": "CORTISOL"
        },
        {
            "tableCode": "22",
            "procedureCode": "40316572",
            "procedureDescription": "VITAMINA B12"
        },
        {
            "tableCode": "22",
            "procedureCode": "40302830",
            "procedureDescription": "25-HIDROXIVITAMINA D"
        }
    ]
}


Erro 400



{
    "code": 400,
    "message": "Corpo da requisição inválido!",
    "detailedMessage": "Obrigatório: 'filter', 'customWhere' e array 'procedures'"
}