Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Método declaracoes
- Regras de Negocio do Método
- EndPoint
Parâmetros de Entrada do Método
Exemplo
Estrutura de Retorno
- Método pdfDeclaracao
- Regras de Negocio do Método
- EndPoint
Parâmetros de Entrada do Método
Exemplo
Estrutura de Retorno
- Método declaracoes
- Tela Declarações
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela Declarações
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
...
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/declaracoes | POST | application/json | Retorna uma lista de declarações |
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
chaveBeneficiario | Sim | Caracter | Chave do Beneficiário (CPF ou Matricula) |
chaveBeneficiarioTipo | Sim | Caracter | Tipo de Login do Beneficiário (CPF ou Matricula) |
multiContract | Sim | Lógico | Utilização de Multi Contratos pelo Beneficiário |
Exemplo
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "chaveBeneficiarioTipo": "CPF", "multiContract": true, "chaveBeneficiario": "76461633090" } |
...
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": false, "motivoCritica": "Nenhum beneficiário encontrado para os parâmetros informados." } |
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 |
tipoDeclaracao | Array | Lista de objetos de “tipoDeclaracao“ |
nome (Objeto tipoDeclaracao) | Caracter | Nome que identifica a lista de declaração |
declaracoes | Array | Lista de objetos de “declaracoes“ |
nome (Objeto declaracoes) | Caracter | Nome que identifica a declaração (Ano + Matricula do Beneficiário) |
idDeclaracao | Caracter | Chave de identificação da declaração no sistema (Ano + Declaração + Matricula) |
codigoContrato | Caracter | Código do Contrato do Beneficiário (Operadora + Empresa + Matricula) |
...
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/pdfDeclaracao | POST | application/json | Retorna a declaração em PDF |
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
idDeclaracao | Sim | Caracter | Chave de identificação da declaração no sistema (Ano + Declaração + Matricula) |
Exemplo
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "idDeclaracao": "2020:CQ:00010050000008002" } |
...
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": false, "motivoCritica": "Não foi possível gerar o PDF" } |
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 |
base64 | Caracter em base64 | Conteúdo binário do tipo base64, do arquivo PDF da declaração. |
url | Caracter | URL completo do arquivo PDF informado no cadastro da Operadora |
...
Import HTML Content
Visão Geral
Conteúdo das Ferramentas