Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Configurações INI
  3. Verbos
  4. Uso da API - POST
  5. Atributos de Resposta
  6. Tabelas utilizadas


01. VISÃO GERAL

A APIauthorizationBatch/{batchCode} tem como objetivo retornar todas as guias que pertencem ao lote informado.


02. CONFIGURAÇÕES IN

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

GEThttps://<url>:porta>/rest/totvsHealthPlans/v1/authorizationBatch/{batchCode}Retorna todas as guias que pertencem ao lote informado

04. USO DA API - GET

        Exemplo de chamada para validação:

http://localhost:8080/rest/totvshealthplans/v1/authorizationBatch/00003282

Image Added

05. ATRIBUTOS DE RESPOSTA

JSON de resposta para lote sem guias encontradas:

Image Added


Bloco de código
titleErro 400
linenumberstrue
{
    "code": 400,
    "message": "Nenhum registro localizado",
    "detailedMessage": "O lote não possui nenhuma guia vinculada."
}


   JSON de resposta para lote com guias encontradas:


Image Added

Bloco de código
titleSucesso 200
linenumberstrue
{
    "items": [
        {
            "idOnHealthInsurer": "000120240200000103"
        },
        {
            "idOnHealthInsurer": "000120240200000105"
        }
    ]
}