Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Método reeExtrato
  1. Regras de Negocio do Método
  2. EndPoint
  3. Parâmetros de Entrada do Método
  4. Exemplo
  5. Estrutura de Retorno
2. Método reeDetalhe
  1. Regras de Negocio do Método
  2. EndPoint
  3. Parâmetros de Entrada do Método
  4. Exemplo
  5. Estrutura de Retorno
3. Método reeHistorico
  1. Regras de Negocio do Método
  2. EndPoint
  3. Parâmetros de Entrada do Método
  4. Exemplo
  5. Estrutura de Retorno
4. Método reeStatus
  1. Regras de Negocio do Método
  2. EndPoint
  3. Parâmetros de Entrada do Método
  4. Exemplo
  5. Estrutura de Retorno
Tela Extrato de ReembolsoTela XXX
1. Outras Ações / Ações relacionadas
Tela XXXExtrato de Reembolso
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

Através do campo URL Document (BA0_MSURDO) no cadastro da operadora, deverá ser informado o caminho de acesso dos arquivos anexados no protocolo para download .

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/reeDetalhe	POST	application/json	Retorna os itens de um protocolo especifico

Parâmetros de Entrada do Método

Parâmetro	Obrigatório	Tipo	Descrição
chaveReembolso	Sim	Caracter	Numero do Protocolo de Reembolso no Sistema

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{
    "chaveReembolso": "00000020180119000055"
}

...

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

{
    "status": false,
    "motivoCritica": "Não existem detalhes a serem visualizados"
}

Estrutura de Retorno

Atributo	Tipo	Descrição
status	Lógico	True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida
motivoCritica	Caracter	Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
itens	Array	Lista de objetos de “itens“
documentos	Array	Lista de objetos de “documentos“
itemId	Caracter	Numero do Protocolo do Reembolso no sistema mais sequencial do item.
procedimento	Caracter	Código do procedimento
procedimentoDescricao	Caracter	Descrição do procedimento
statusId	Numérico	Código do status, conforme retorno do método reeStatus.
cidade	Caracter	Cidade do Atendimento
estado	Caracter	Estado do Atendimento
dataExecucao	Caracter	Data de execução do procedimento (Formato: YYYY-MM-DD)
documentoTipo	Caracter	Tipo do Documento do Reembolso
documentoNumero	Caracter	Numero do Documento
quantidadeExecutada	Numérico	Quantidade Realizada
valorApresentado	Numérico	Valor apresentado no Protocolo
valorReembolsado	Numérico	Valor reembolsado pela Operadora
observacao	Caracter	Não utilizado
nomeApresentacao	Caracter	Descrição do Arquivo
nomeArquivo	Caracter	Arquivo com a extensão.
caminhoArquivo	Caracter	URL do Arquivo no servidor para download.

Método reeHistorico

Este método irá retornar o histórico de alterações de status do protocolo de reembolso.

...

Esse método irá receber a chave do reembolso que foi retornado no método reeExtrato.

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/reeHistorico	POST	application/json	Retorna o histórico de alterações de status do protocolo de reembolso

Parâmetros de Entrada do Método

Parâmetro	Obrigatório	Tipo	Descrição
chaveReembolso	Sim	Caracter	Numero do Protocolo de Reembolso no Sistema

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{
    "chaveReembolso": "00000020180119000055"
}

...

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

{
    "status": false,
    "motivoCritica": "Não existem históricos a serem visualizados"
}

Estrutura de Retorno

Atributo	Tipo	Descrição
status	Lógico	True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida
motivoCritica	Caracter	Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
historico	Array	Lista de objetos de “historico“
dataHora	Caracter	Data e Hora da movimentação do status do Reembolso
statusId	Caracter	Código do status, conforme retorno do método reeStatus.

Método reeStatus

Retorna os status do protocolo de reembolso, para montagem das legendas da listagem referente aos métodos reeExtrato, reeDetalhe e reeHistorico.

...

Segue tabela abaixo dos status da API relacionados com os status do protocolo de reembolso no remote:

Status na API	Status no Remote
0 = Solicitação não concluida	A = Solicitação não concluída
1 = Protocolado	0 = Solicitado (Portal) ; 1 = Protocolado
2 = Em Analise	2 = Em analise ; 3 = Deferido ; 5 = Em digitacao ; 9 = Auditoria
3 = Aprovado	6 = Lib. financeiro ; Legenda Verde do Item do Reembolso
4 = Rejeitado	4 = Indeferido ; 7 = Nao lib. financeiro ; 8 = Glosado ; Legenda Vermelho do Item do Reembolso
5 = Aguardando informação do beneficiário	B = Aguardando informação do Beneficiário
6 = Aprovado parcialmente	C = Aprovado Parcialmente
7 = Cancelado	D = Cancelado
8 = Reembolso revertido	E = Reembolso Revertido

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/reeStatus	POST	application/json	Retorna os status de autorização

Parâmetros de Entrada do Método

...

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
    "status": true,
    "reembolsoStatus": [
        {
            "chaveStatus": "0",
            "descricao": "Solicitação não concluida"
        },
        {
            "chaveStatus": "1",
            "descricao": "Protocolado"
        },
        {
            "chaveStatus": "2",
            "descricao": "Em Analise"
        },
        {
            "chaveStatus": "3",
            "descricao": "Aprovado"
        },
        {
            "chaveStatus": "4",
            "descricao": "Rejeitado"
        },
        {
            "chaveStatus": "5",
            "descricao": "Aguardando informação do beneficiário"
        },
        {
            "chaveStatus": "6",
            "descricao": "Aprovado parcialmente"
        },
        {
            "chaveStatus": "7",
            "descricao": "Cancelado"
        },
        {
            "chaveStatus": "8",
            "descricao": "Reembolso revertido"
        }
    ]
}

Estrutura de Retorno

Atributo	Tipo	Descrição
status	Lógico	True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida
motivoCritica	Caracter	Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
reembolsoStatus	Array	Lista de objetos de “reembolsoStatus“
chaveStatus	Caracter	Código de identificação do status do Reembolso
descricao	Caracter	Descrição do status

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

...

Campo	Descrição

05. TABELAS UTILIZADAS

BOW - Protocolo de Reembolso

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Endpoint

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Método reeHistorico

Endpoint

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Método reeStatus

Endpoint

Parâmetros de Entrada do Método

Estrutura de Retorno

05. TABELAS UTILIZADAS