Este documento tem como objetivo demonstrar a utilização da API PLAltBenModel, onde será realizada a solicitação de um novo protocolo de alteração de beneficiários.
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.
Foi desenvolvido o modelo de dados (ModelDef) para alterar beneficiários, e através da classe FWRestModel foi feita a publicação do modelo para que seja consumido via API padrão REST.
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.
Além disso, a API poderá receber alguns filtros (QueryStrings) no headers da requisição, como:
Key | Descrição |
|---|---|
| STARTINDEX | Indica a partir que qual index deverá ser retornado (padrão: 1) |
| INTERNALID | Indica se deve retornar o ID(Recno) como informação complementar das linhas do GRID (padrão: false) |
| FIRSTLEVEL | Habilita o retorno dos sub modelos (padrão: true) |
| FILTER | Filtro que será aplicado no método SetFilter() |
| FIELDVIRTUAL | Habilita o retorno de campos virtuais (padrão: false) |
| FIELDS | Indica os campos a serem filtrados no retorno do modelo, incluindo os sub modelos, caso não informado todos os campos serão retornados |
| FIELDEMPTY | Habilita o retorno de campos sem valores (padrão: false) |
| FIELDDETAIL | Habilita mostrar mais informações nos campos do modelo (padrão: 10) |
| DEBUG | Valor booleano para habilitar o modo debug (padrão: false) |
| COUNT | Quantidade de registro que devem ser retornados (padrão: 10) |
| CACHE | Indica se sera feito cache do total de registros por alias, refere-se ao valor do total no retorno (padrão: true) |
Exemplo de utilização: Key igual FILTER e value igual BBA_CODSEQ=000770, será retornado somente o protocolo com o código sequencial com o numero 000770.
Para mais informações de como utilizar esse modelo de API, acessem a documentação da classe FWRestModel. |
A autenticação da API é realizado pelo headers Authorization, Type Basic Auth, Usuário e Senha do Protheus.
Algumas regras na API poderão ser adicionadas pelo Layout genérico Web, o mesmo deverá ser adicionada no MV_PLLAYAL.
Por exemplo: PPLALTBEN, a api irá utilizar as configurações contidas nessa layout genérico.
Pelo Layout o sistema irá utilizar as seguintes regras no modelo de dados para alteração de beneficiários:
Esse configuração de VALIDA é realizada na Configuração Complementar (B2C) do Layout Genérico, informando a variável VALIDA e o valor .T., ou seja, o campo irá passar por analise, caso não seja informado a variável VALIDA, será feita a atualização automática dos dados no cadastro do beneficiário (BA1). Para mais informações sobre o cadastro do Layout Genérico Web, acessem esse link: Layout Genérico Web - PLSCADLAY
Se todos os campos forem atualizados automaticamente, o protocolo ficará com o status igual a Aprovado Automaticamente (BBA_STATUS igual a 7), se pelo menos algum campo precisar de analise, o status será Em Analise (BBA_STATUS igual a 2).
| O Layout utilizado na API, deverá utilizar exclusivamente a tabela BA1. |
Abaixo será apresentado um exemplo de cada método da API PLIncBenModel.
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |