Histórico da Página
CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Tela XXX
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela XXX
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
Este documento tem como objetivo demonstrar a utilização da API
...
PLINCBENMODEL , onde será realizada a solicitação de um novo protocolo de inclusão de titulares e dependentes.
Os protocolos serão gerados na rotina de Analise de Beneficiários (PLSA977AB) para que a Operadora analise as solicitações.
A API utilizará o padrão REST.
02. EXEMPLO DE UTILIZAÇÃO
A API Foi desenvolvido o modelo de dados (ModelDef) para incluir beneficiários, e através da classe FWRestModel foi feita a publicação do modelo para que seja consumido via API padrão REST.
Segue os métodos que poderá ser utilizados na API:
| Verbo | Patch | Descrição |
|---|---|---|
| GET | /fwmodel |
| /PLINCBENMODEL/[pk] | Retorna os protocolo da analise de beneficiários, para retornar somente um protocolo deverá ser informado a pk do mesmo. |
| POST | /fwmodel/ |
| PLINCBENMODEL | Realiza a inclusão de um novo protocolo na analise de beneficiários |
| PUT | /fwmodel/ |
| PLINCBENMODEL/[pk] | Realiza a alteração de um protocolo de inclusão já existente na analise de beneficiários. |
| DELETE | /fwmodel/ |
| PLINCBENMODEL/[pk] |
...
| Realiza a deleção de um protocolo já existente na analise de beneficiários. (Somente os protocolos que não foram analisados ou finalizados poderão ser excluidos) |
Para retornar a lista de registros referente ao modelo de dados deve-se efetuar um GET sem informar a <PK>. Os registros listados terão filtrados pelas filiais que o usuário tem acesso (isso se o campo filial existir.)
Para inserir um registro deve-se efetuar um POST sem informar a <PK> e enviar no body o conteúdo a ser inserido.
Ao informar o parâmetro <PK> será acessado um registro em específico e assim podendo ser utilizado os métodos GET, PUT, DELETE.
03. TELA XXXXX
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
04. TELA XXXXX
Principais Campos e Parâmetros
...
| Card documentos | ||||
|---|---|---|---|---|
|
05. TABELAS UTILIZADAS
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas