Árvore de páginas

Versões comparadas

Chave

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

...

  1. Visão Geral
  2. Exemplo de utilização
    1. Método declaracoes
      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 pdfDeclaracao
      1. Regras de Negocio do Método
      2. EndPoint
      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

  3. Tela Declarações 
    1. Outras Ações / Ações relacionadas
  4. Tela Declarações 
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas

...

Url

Método

Header Content-Type

Descrição

https://<url>:<porta>/rest/mobileSaude/v1/declaracoesPOSTapplication/jsonRetorna uma lista de declarações

Parâmetros de Entrada do Método

Parâmetro

Obrigatório

Tipo

Descrição

chaveBeneficiarioSimCaracterChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoSimCaracterTipo de Login do Beneficiário (CPF ou Matricula)
multiContractSimLógicoUtilização de Multi Contratos pelo Beneficiário

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": true,
    "chaveBeneficiario": "76461633090"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Nenhum beneficiário encontrado para os parâmetros informados."
}

Estrutura de Retorno

AtributoTipoDescrição
statusLógico

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

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

motivoCriticaCaracterMotivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
tipoDeclaracaoArrayLista de objetos de “tipoDeclaracao
nome (Objeto tipoDeclaracao)CaracterNome que identifica a lista de declaração
declaracoesArrayLista de objetos de “declaracoes
nome (Objeto declaracoes)CaracterNome que identifica a declaração (Ano + Matricula do Beneficiário)
idDeclaracaoCaracterChave de identificação da declaração no sistema (Ano + Declaração + Matricula)
codigoContratoCaracterCódigo do Contrato do Beneficiário (Operadora + Empresa + Matricula)

...

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

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
idDeclaracaoSimCaracterChave de identificação da declaração no sistema (Ano + Declaração + Matricula)

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "idDeclaracao": "2020:CQ:00010050000008002"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF"
}

Estrutura de Retorno

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
base64Caracter em base64Conteúdo binário do tipo base64, do arquivo PDF da declaração.
urlCaracterURL completo do arquivo PDF informado no cadastro da Operadora

...