Árvore de páginas

Versões comparadas

Chave

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

...

Quando o beneficiário solicitado for um dependente, será retornado apenas as suas próprias autorizações.

Endpoint

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaAutorizacoesPOSTapplication/jsonRetorna uma lista com as guias de autorização

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveBeneficiarioSimStringChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoSimStringTipo de Login do Beneficiário(CPF ou Matricula)
multiContractSimBooleanUtilização de Multi Contratos pelo Beneficiário
dataInicialNãoStringData inicial do extrato de autorizações
dataFinalNãoStringData final do extrato de autorizações

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": true,
    "chaveBeneficiario": "76461633090",
    "dataInicial": "2022-01-01",
    "dataFinal": "2022-02-04"
}

...

Este método irá retornar os detalhes (itens) de uma guia de autorização.

Regras de Negocio do Método

...

Quando o beneficiário solicitado for um dependente, será retornado apenas as suas próprias autorizações.


Endpoint

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/
guiaAutorizacoes
guiaDetalhePOSTapplication/jsonRetorna
uma lista com as guias
eventos (itens) da guia de autorização

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveAutorizacaoSimStringChave única de identificação da guia de autorização

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveAutorizacao": "BEA|000120220200000005"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não existem itens a serem visualizados"
}

Método guiaPdf

Este método irá retornar uma URL ou uma string BASE64 do arquivo PDF da guia completa.

Regras de Negocio do Método


Endpoint

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaPdfPOSTapplication/jsonRetorna a guia completa em PDF

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveAutorizacaoSimStringChave única de identificação da guia de autorização

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveAutorizacao": "BEA|000120220200000005"
}
Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "status": true,
    "url": "c:\\protheus12127\\protheus_data\\web\\pp\\imagens-pls\\relatorios\\guisadtsc034810.pdf",
    "binario": ""
}
Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF da Guia"
}





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

...