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 4 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
typeB1R_HATTIP

Código da ação(E=Exclusão, 0=Inclusão)

Default: Inclusão

Caracter


VERBO POST

Através do verbo POST, a API permite realizar a solicitação de inclusão de um novo profissional no Corpo Clínico.

Caso o parametro MV_PLINBC1 esteja desativado, esta solicitação deve ser analisada posteriormente na rotina Análise de Alterações Cadastrais (PLSA814). A solicitação POST permite realizar também, o upload de um arquivo para análise do Auditor (o arquivo deve ser enviado no formato Base 64).


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"
}


05. ATRIBUTOS DE RESPOSTA

Solicitação GET

AtributoCampoTipo
idOnHealthInsurerBC1_CODRDACaracter
professionalCouncilBC1_SIGLCRCaracter
professionalCouncilNumberBC1_NUMCRCaracter
stateAbbreviationBC1_ESTCRCaracter
nameBC1_NOMPRFCaracter
idR_E_C_N_O_Caracter


Solicitação POST

Atributo

Campo

Tipo

code

Campo fixo que indica a ação encontrada: 0001

Caracter
message

Mensagem indicativa referente ao código acima:

0001 - Pedido de inclusao gerado com sucesso

0002 - Não foi encontrada guia, e possível realizar o reenvio

Caracter


06. EXEMPLOS DE JSON DE RESPOSTA


Solicitação GET:


{
    "items": [
        {
            "idOnHealthInsurer": "000008",
            "professionalCouncil": "",
            "professionalCouncilNumber": "",
            "id": 8,
            "name": "",
            "stateAbbreviation": ""
        },
        {
            "idOnHealthInsurer": "000005",
            "professionalCouncil": "",
            "professionalCouncilNumber": "",
            "id": 9,
            "name": "",
            "stateAbbreviation": ""
        },
        {
            "idOnHealthInsurer": "000003",
            "professionalCouncil": "CRM",
            "professionalCouncilNumber": "555555",
            "id": 10,
            "name": "RDA CLAUDIA",
            "stateAbbreviation": "SP"
        },
        {
            "idOnHealthInsurer": "",
            "professionalCouncil": "CRM",
            "professionalCouncilNumber": "654987",
            "id": 11,
            "name": "DAIANE BERNARDE BATISTA",
            "stateAbbreviation": "SP"
        },
        {
            "idOnHealthInsurer": "",
            "professionalCouncil": "CRO",
            "professionalCouncilNumber": "321987",
            "id": 12,
            "name": "ALMIRO NOGUEIRA FILHO",
            "stateAbbreviation": "SP"
        },
        {
            "idOnHealthInsurer": "000007",
            "professionalCouncil": "CRM",
            "professionalCouncilNumber": "19011985",
            "id": 13,
            "name": "RDA SILVIA SANT ANNA",
            "stateAbbreviation": "SP"
        }
    ],
    "hasNext": false
}
{
    "code": 400,
    "message": "Registros nao encontrados",
    "detailedMessage": "Nao foi encontrado o corpo clinico para os parametros informados",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}



Solicitação POST:

{
    "code": "0001",
    "message": "Pedido de inclusao gerado com sucesso: 000030"
}
{
    "code": 400,
    "message": "Falha ao criar pedido",
    "detailedMessage": "Nao foi possivel gerar o pedido de inclusao de Profissional no Corpo Clinico",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}


Solicitação PUT - Bloqueio de Profissional

Sucesso - HTTP Status 200

{
    "code": 400,
    "message": "Registros nao encontrados",
    "detailedMessage": "Nao foi encontrado corpo clinico com o id informado",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}