Árvore de páginas

Versões comparadas

Chave

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

...

Se os parâmetros Data Inicial e  Data Final não forem informados, será retornado uma lista de autorizações de acordo com a quantidade de meses cadastrado no campo Qt. Meses G. (BA0_MSGUIA). Caso o campo não seja encontrado na base de dados, será utilizado o período de verificação dos últimos 12 meses.

Se o Login for realizado por CPF, o sistema irá listar as autorizações de todos os contratos vinculado aquele CPF.

Se o Login for realizado por matricula, o sistema irá listar somente as autorizações daquele contrato.

Quando o beneficiário solicitado for o titular, será retornado as suas autorizações e de todo o grupo familiar.

...

ParâmetroObrigatórioTipoDescrição
chaveBeneficiarioSimNãoCaracterChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoSimNãoCaracterTipo de Login do Beneficiário (CPF ou Matricula)
multiContractSimNãoLógicoUtilização de Multi Contratos pelo Beneficiário
dataInicialNãoCaracterData inicial do extrato de autorizações
dataFinalNãoCaracterData final do extrato de autorizações

matriculaContrato

SimCaracterMatricula do Beneficiário

Exemplo
Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": truefalse,
    "chaveBeneficiario": "7646163309082737323800",
    "dataInicial": "2022-0107-01",
    "dataFinal": "2022-0207-04"
},
	"matriculaContrato": "00011008000019017" 
}
Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "status": true,
    "autorizacoes": [
        {
            "dataAutorizacaochaveAutorizacao": "2022-02-04BEA|000120220700000002",
            "tipoTratamentobeneficiarioMatricula": "SP/SADT00011008000019017",
            "numeroPedidobeneficiarioNome": "20220200000005",
RUAN CAUA           "dataSolicitacao": "2022-02-04"DA COSTA",
            "senha statusId": ""1,
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 3,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BEA|000120220200000005"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "QUIMIOTERAPIA",
            "numeroPedido": "20220200000002",
            "dataSolicitacao": "2022-02-03",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4A|000120220200000002"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "RADIOTERAPIA",
            "numeroPedido": "20220200000003",
            "dataSolicitacao": "2022-02-03",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4A|000120220200000003"
        },
        {
            "dataAutorizacao": "2022-02-03",
            "tipoTratamento": "CONSULTA",
            "numeroPedido": "20220200000001",
            "dataSolicitacao": "2022-02-03",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 6,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BEA|000120220200000001"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "OPME",
            "numeroPedido": "20220100000004",
            "dataSolicitacao": "2022-01-24",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4A|000120220100000004"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "PRORROGACAO DE INTERNACAO",
            "numeroPedido": "20220100000005",
            "dataSolicitacao": "2022-01-24",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4Q|000120220100000005"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "INTERNACAO",
            "numeroPedido": "20220100000001",
            "dataSolicitacao": "2022-01-24",
            "senha ": "9289259502119996",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BE4|000120220100000001"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "SP/SADT",
            "numeroPedido": "20220100000002",
            "dataSolicitacao": "2022-01-24",
            "senha ": "",
            "beneficiarioMatricula": "00019875000001011",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BEA|000120220100000002"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "SP/SADT",
            "numeroPedido": "20220100000003",
            "dataSolicitacao": "2022-01-24",
            "senha ": "dataSolicitacao": "2022-07-04",
            "beneficiarioMatriculadataAutorizacao": "000110070000010122022-07-04",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusIdespecialidade": "CLINICA 1MEDICA",
            "beneficiarioNometipoTratamento": "CATELYN STARKCONSULTA",
            "especialidadenumeroPedido": "CLINICA MEDICA20220700000002",
            "chaveAutorizacaosenha ": "BEA|000120220100000003"
        }
    ]
}
Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "NãoUm existematributo autorizaçõesobrigatório anão seremfoi visualizadasinformado."
}

Estrutura de Retorno
Âncora
AUTORIZACAORETORNO
AUTORIZACAORETORNO

...

AtributoTipoDescrição
statusLógico

True: Indica que a requisição foi bem-sucedida

False: Indica que a requisição foi mal sucedida

motivoCriticaCaracter Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
autorizacaoStatusArrayLista de objetos de “autorizacaoStatus“
chaveStatusCaracterCódigo de identificação do status da autorização
descricaoCaracterDescrição do status

Veja um exemplo de como a comunicação com a API é feita na prática: 

...

03. TELA EXTRATO DE AUTORIZAÇÕES
Âncora
TELAAUTORIZACOES1
TELAAUTORIZACOES1

...