Histórico da Página

CONTEÚDO

1. Visão Geral
2. Configurações INI
3. Verbos
   
4. Exemplos de chamada da API
   
5. Atributos de Resposta
6. Pontos de Entrada

01. VISÃO GERAL

A API procedures foi desenvolvida para ser utilizada em conjunto com o Portal Autorizador (HAT) auxiliando a busca de procedimentos nas rotinas de Digitação de Guias e Jornadas de Atendimento.

VERBO GET

Através do verbo GET, a API retorna os eventos disponíveis para utilização realizando a busca através de um filtro complexo ou por código de procedimento (via pathparam).

Exemplos: 

• Via filtro complexo: http://localhost:8080/rest/totvshealthplans/v1/procedures?action=typeAhead&pageSize=7&customWhere=1&filter=(tableCode%20eq%20%2718%27%20or%20tableCode%20eq%20%2719%27%20or%20tableCode%20eq%20%2720%27%20or%20tableCode%20eq%20%2722%27%20or%20tableCode%20eq%20%2700%27%20or%20tableCode%20eq%20%2798%27)%20and%20%20procedureId%20startswith(%27CONSULTA%27)%20or%20procedureDescription%20startswith(%27CONSULTA%27)&procedureId=10101012
• Via ID (pathparam): http://localhost:8080/rest/totvshealthplans/v1/procedures/10101012

A API também tem dois recursos para retornar dentes e faces:

• Dentes (teethRegions): http://localhost:8080/rest/totvshealthplans/v1/procedures/2282000026/teethRegions?page=1&pageSize=7
• Faces (surfaces): http://localhost:8080/rest/totvshealthplans/v1/procedures/2282000026/teethRegions/12/surfaces?page=1&pageSize=10

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/procedures. Exemplo:

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

03. VERBOS

Seguem os verbos disponíveis na API: 

04. EXEMPLOS DE CHAMADA DA API

Chamada por filtro complexo:

Para o funcionamento correto da API, informar os QueryParams:

Exemplo da chamada filtrando por filter:

http://localhost:8080/rest/totvshealthplans/v1/procedures?action=typeAhead&pageSize=7&customWhere=1&filter=(tableCode%20eq%20%2718%27%20or%20tableCode%20eq%20%2719%27%20or%20tableCode%20eq%20%2720%27%20or%20tableCode%20eq%20%2722%27%20or%20tableCode%20eq%20%2700%27%20or%20tableCode%20eq%20%2798%27)%20and%20%20procedureId%20startswith(%27CONSULTA%27)%20or%20procedureDescription%20startswith(%27CONSULTA%27)&procedureId=10101012

Exemplo de chamada por tableCode e procedureId:

http://localhost:8080/rest/totvshealthplans/v1/procedures?action=typeAhead&pageSize=7&customWhere=1&tableCode=22&procedureId=10101012

Chamada por procedureID:

Esta busca retorna o primeiro registro encontrado com o pathparam informado. Realizado a busca por 10101012:

http://localhost:8080/rest/totvshealthplans/v1/procedures/10101012

Busca por dentes

Retorna os dentes de um procedimento de Odonto:

http://localhost:8080/rest/totvshealthplans/v1/procedures/2282000026/teethRegions?page=1&pageSize=7

Busca por faces

Retorna as faces de um dente de um procedimento de Odonto:

http://localhost:8080/rest/totvshealthplans/v1/procedures/2282000026/teethRegions/12/surfaces?page=1&pageSize=10

05. ATRIBUTOS DE RESPOSTA

• Chamadas GET:

  Atributo	Campo Protheus	Tipo
  manufacturer	BTQ_FABRIC	Caracter
  procedureId	BTU_CODTAB + BTU_CDTERM ou BTQ_CODTAB + BTQ_CDTERM	Caracter
  procedureCode	BTU_CDTERM ou BTQ_CDTERM	Caracter
  procedureType	BR8_TPPROC	Caracter
  inSerie	BJE_TIPO = '2' (o registro BJE é vinculado ao BR8_CLASSE	Boolean
  eventType	BR8_TIPEVE	Caracter
  procedureDescription	BR8_DESCRI	Caracter
  anvisaId	Sempre vazio (mantido para manter a integridade já existente)	Caracter
  tableCode	BTU_CODTAB ou BTQ_CODTAB	Caracter
  manufacturerReference	BTQ_REFFAB	Caracter

  
  

  Exemplo de resposta com evento encontrado (filtro complexo):

  Bloco de código
  title Sucesso 202
  { "items": [ { "manufacturer": "", "procedureId": "2210101012", "procedureCode": "10101012", "procedureType": "0", "inSerie": false, "eventType": "", "procedureDescription": "CONSULTA EM CONSULTORIO", "anvisaId": "", "tableCode": "22", "manufacturerReference": "" } ], "hasNext": false }

  
  

  Exemplo de resposta com evento encontrado (busca por ID):

  Bloco de código
  title Sucesso 202
  { "manufacturer": "", "procedureId": "2210101012", "procedureCode": "10101012", "procedureType": "0", "inSerie": false, "eventType": "", "procedureDescription": "CONSULTA EM CONSULTORIO", "anvisaId": "", "tableCode": "22", "manufacturerReference": "" }

  
  

  Em buscas por filtro complexo, a quantidade mínima de caracteres para realizar a busca é 3. Se forem informados menos que 3, será apresentada uma mensagem impeditiva:

  Bloco de código
  title Sucesso 202
  { "code": 200, "message": "Nao foram localizados resultados com os valores informados", "detailedMessage": "O servidor nao foi capaz de entender a solicitacao", "helpUrl": "", "details": [ { "code": "", "message": "", "detailedMessage": "", "helpUrl": "" } ] }

  
  

  Em buscas por filtro complexo, a quando não for encontrado um evento com os parâmetros informados:

  Bloco de código
  title Sucesso 202
  { "items": [], "hasNext": false }

Em buscas por filtro complexo, a quando não for encontrado um evento com os parâmetros informados:

{
    "items": [
        {
            "procedureCode": "82000026",
            "terminologyCode": "11",
            "description": "Incisivo Central Superior Direito",
            "hasSurfaces": "1",
            "permanent": true,
            "deciduous": false
        },
        {
            "procedureCode": "82000026",
            "terminologyCode": "12",
            "description": "Incisivo Lateral Superior Direito",
            "hasSurfaces": "1",
            "permanent": true,
            "deciduous": false
        }
    ],
    "hasNext": false
}

06. PONTOS DE ENTRADA

Foram implementados os pontos de entrada PLRSTPR1 e PLRSTPR2 para auxiliarem na API.

PLRSTPR1

O ponto de entrada PLRSTPR1 permite customizar a Query que será executadas para buscar os procedimentos.

Parâmetros:

Retorno:

Exemplo de Ponto de Entrada:

User Function PLRSTPR1()

    Local cSql := paramixb[1]
    Local cType := paramixb[2]
    Local cFilter  := paramixb[3]
    Local cTableCode := paramixb[4]
    Local cProcedID := paramixb[5]
    Local lSrcTabCode  := paramixb[6]

    //Implementar ajuste desejado
   
Return cSql

PLRSTPR2

O ponto de entrada PLRSTPR2 permite customizar o json de resposta. O ponto será executado para cada evento encontrada na Query. É possível capturar um dado da query utilizando o Alias TRB→ (consultar o exemplo abaixo). A lista com todos os Alias podem ser encontradas analisando a Query informada no ponto de entrada PLRSTPR1.

Parâmetros:

Retorno:

Exemplo de Ponto de Entrada:

User Function PLRSTPR2()

    Local oItem := paramixb[1]
    Local cItem := ''
    
    //Implementar ajuste desejado
    cItem := oItem:toJson()
    Conout('Procedure description: ' + TRB->PROCEDUREDESCRIPTIONJSON) //Capturando descricao do evento no alias TRB
    Conout('Json do objeto posicionado: ' + cItem) //Imprimindo Json do Evento posicionado

Return oItem