Histórico da Página
...
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 do beneficiáriode beneficiários.
Os protocolos serão gerados na rotina de Analise de Beneficiários (PLSA977AB) para que a Operadora analise as solicitações.
...
| Informações | ||
|---|---|---|
| ||
Para mais informações de como utilizar esse modelo de API, acessem a documentação da classe FWRestModel. |
A autenticação da API é realizado realizada pelo headers Authorization, Type Basic Auth, Usuário e Senha do Protheus.
...
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| pk | Não | Caracter | Valor da chave primaria do alias do modelo em encodado em base64, esse valor será obtido ao consulta consultar todos os protocolos. |
Exemplo
...
Parâmetro (fields) | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| BBA_MATRIC | Sim | Caracter | Matricula do Beneficiário que será feito feita a atualização dos dados. |
| B7L_CAMPO | Sim | Caracter | Campo do sistema para realizar a alteração (Tabela BA1). |
| B7L_VLPOS | Sim | Caracter | Novo Conteúdo do campo. |
| B7L_USR | Sim | Caracter | Usuário que solicitou a alteração. |
| DIRECTORY | Não | Caracter | Diretório http do arquivo para anexar ao protocolo de alteração. |
| FILENAME | Não | Caracter | Nome para ao arquivo. |
...
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
https://<url>:<porta>/rest/fwmodel/PLAltBenModel/[pk] | PUT | application/json | Realiza a alteração de um protocolo já existente na analise de beneficiários. (Somente os protocolos que não foram analisados ou finalizados poderão ser excluídosalterados). |
Parâmetro <PK> obtido através dos métodos POST ou GET.
...
O JSON de envio do PUT é o mesmo realizado no POST, o que irá mudar é o atributo operation com o valor 4 e o valor dos campos que irá irão ser alteradoalterados.
O retorno da API será o mesmo do POST. Caso realizado a alteração com sucesso, será retornado o protocolo como se tivesse realizado um GET com a pk correspondente ao protocolo. Caso ocorra alguma validação será apresentada a critica.
...
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
https://<url>:<porta>/rest/fwmodel/PLAltBenModel/[pk] | DELETE | application/json | Realiza a deleção exclusão de um protocolo já existente na analise de beneficiários. (Somente os protocolos que não foram analisados ou finalizados poderão ser excluídos). |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas