CONTEÚDO

  1. Visão Geral
  2. Exemplo de Chamada da API
  3. Atributos de Resposta
  4. Exemplos de JSON de Resposta

01. VISÃO GERAL

A API xmlManager tem como objetivo, receber um XML de faturamento e realizar a inclusão nas tabelas do sistema de gestão Plano de Saúde para que seja feita a submissão e validação do mesmo.


VERBO POST

Através do verbo POST, a API pode incluir o XML na pasta e gravar as tabelas BXX e B1R. Esta solicitação é feita através de 3 Queryparams para realizar este filtro:

QueryParamCampoDescriçãoTipo de Dado
healthProviderB1R_ORIGEM/BXX_CODRDACódigo Rede de AtendimentoCaracter
fileNameBXX_ARQINNome do arquivoCaracter
batchNumberB1R_PROTOG/BXX_PLSHATProtocolo origem Caracter

VERBO DELETE

Através do verbo DELETE, a API pode excluir o XML. Esta solicitação é feita através de 2 Queryparams para realizar este filtro:

QueryParamCampoDescriçãoTipo de Dado
healthProviderB1R_ORIGEM/BXX_CODRDACódigo Rede de AtendimentoCaracter
batchNumberB1R_PROTOG/BXX_PLSHATProtocolo origem Caracter


02. EXEMPLO DE CHAMADA DA API

Chamada POST

http://10.171.80.125:3211/rest/totvshealthplans/v1/xmlManager?healthProvider=000005&fileName=faturamento.xml&batchNumber=00003607




{
    "message": "Protocolo criado com sucesso",
    "success": true,
    "protocolo": "000000023675"
}


Chamada DELETE

http://10.171.80.125:3211/rest/totvshealthplans/v1/xmlManager?healthProvider=000005&batchNumber=00003607




{
    "message": "Protocolo excluido com sucesso",
    "success": true
}