Histórico da Página
...
...
Segue os métodos utilizados na API:
- declaracoeslistaDeclaracoes: Retorna uma lista de declarações do beneficiário.
- pdfDeclaracaodeclaracaoPdf: Retorna uma URL ou um caracter BASE64 contendo o arquivo PDF da declaração.
...
A autenticação é realizada através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.
Método
...
listaDeclaracoesÂncora DECLARACAO DECLARACAO
| DECLARACAO | |
| DECLARACAO |
Este método irá retornar todas as declarações (Carta de Quitação e Declaração anual de Imposto de Renda) solicitadas pelo beneficiário.
...
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/declaracoeslistaDeclaracoes | POST | application/json | Retorna uma lista de declarações |
...
| 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) |
Método
...
declaracaoPdfÂncora PDF PDF
Este método irá retornar uma URL ou um caracter BASE64 contendo o arquivo PDF da declaração.
...
Esse método irá receber a chave de identificação da declaração que foi retornado no método declaracoes listaDeclaracoes. A Chave deverá conter o ano, tipo da declaração a ser gerada e a matricula do beneficiário.
...
| Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/pdfDeclaracaodeclaracaoPdf | POST | application/json | Retorna a declaração em PDF |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas