Histórico da Página
CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Layout Genérico Web
- Get API
- Post API
- Put API
- Delete API
- Tela API PLAltBenModel
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela API PLAltBenModel
- 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 PLAltBenModel, onde será realizada a solicitação de um novo protocolo de alteração de beneficiários.
...
A API utilizará o padrão REST.
02. EXEMPLO DE UTILIZAÇÃO
Foi desenvolvido o modelo de dados (ModelDef) para alterar os dados do beneficiário, e através da classe FWRestModel foi feita a publicação do modelo para que seja consumido via API padrão REST.
...
A autenticação da API é realizada pelo headers Authorization, Type Basic Auth, Usuário e Senha do Protheus.
LAYOUT GENÉRICO WEB
Algumas regras na API poderão ser adicionadas pelo Layout genérico Web, o mesmo deverá ser adicionada no MV_PLLAYAL.
...
Abaixo será apresentado um exemplo de cada método da API PLAltBenModel.
GET API
Endpoint
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
https://<url>:<porta>/rest/fwmodel/PLAltBenModel/[pk] | GET | application/json | Retorna os protocolo da analise de beneficiários, para retornar somente um protocolo deverá ser informado a pk do mesmo. |
Parâmetro <PK> é opcional, sendo usado pra retornar os detalhes de um protocolo.
Parâmetros de Entrada do Método
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 consultar todos os protocolos. |
Exemplo
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
...
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"errorCode": 404,
"errorMessage": "The server can't find the requested resource."
} |
POST API
Endpoint
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
https://<url>:<porta>/rest/fwmodel/PLAltBenModel/ | POST | application/json | Realiza a inclusão de um novo protocolo de alteração na analise de beneficiários |
Parâmetros de Entrada do Método
Parâmetro (fields) | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| BBA_MATRIC | Sim | Caracter | Matricula do Beneficiário que será 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. |
Os demais parâmetros do json, segue o mesmo padrão para toda requisição de POST.
Exemplo
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"id": "PLAltBenModel",
"operation": 3,
"models": [
{
"id": "MASTERBBA",
"modeltype": "FIELDS",
"fields": [
{
"id": "BBA_MATRIC",
"order": 1,
"value": "00011008000019017"
}
],
"models": [
{
"id": "DETAILB7L",
"modeltype": "GRID",
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "B7L_CAMPO",
"value": "BA1_EMAIL"
},
{
"id": "B7L_VLPOS",
"value": "[email protected]"
},
{
"id": "B7L_USER",
"value": "API TOTVS"
}
]
}
]
},
{
"id": "DETAILANEXO",
"modeltype": "GRID",
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "DIRECTORY",
"value": "https://centraldeatendimento.totvs.com/hc/article_attachments/360027449931/mceclip2.png"
},
{
"id": "FILENAME",
"value": "Teste_alteracao"
}
]
}
]
}
]
}
]
} |
...
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"errorCode": 400,
"errorMessage": "\r\n --- Erro no Modelo ---\r\nId submodelo origem:[DETAILB7L]\r\nId campo origem:[VLDDATA_POST]\r\nId submodelo erro: [DETAILB7L]\r\nId campo erro: []\r\nId erro: [VALID ]\r\nMensagem de erro: [ O campo (B7L_VLPOS) não foi preenchido.[Item: 1]]\r\nMensagem da solução: [\r\n]\r\nValor atribuído: []\r\nValor anterior: []\r\n"
} |
PUT API
Endpoint
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 alterados). |
Parâmetro <PK> obtido através dos métodos POST ou GET.
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| pk | Sim | Caracter | Valor da chave primaria do alias do modelo em encodado em base64. |
Exemplo
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ão ser alterados.
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.
DELETE API
Endpoint
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
https://<url>:<porta>/rest/fwmodel/PLAltBenModel/[pk] | DELETE | application/json | Realiza a 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). |
Parâmetro <PK> obtido através dos métodos POST ou GET.
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| pk | Sim | Caracter | Valor da chave primaria do alias do modelo em encodado em base64. |
Exemplo
O JSON de envio do DELETE é o mesmo realizado no POST ou no PUT, o que irá mudar é o atributo operation com o valor 5.
...
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"errorCode": 400,
"errorMessage": "\r\n --- Erro no Modelo ---\r\nId submodelo origem:[]\r\nId campo origem:[]\r\nId submodelo erro: [PLAltBenModel]\r\nId campo erro: []\r\nId erro: [VALID ]\r\nMensagem de erro: [ Não é permitido excluir ou alterar protocolo de solicitação quando estiver em analise ou finalizado.]\r\nMensagem da soluçãoo: [\r\n]\r\nValor atribuído: []\r\nValor anterior: []\r\n"
} |
03. TELA API PLALTBENMODEL
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica | Não se aplica |
04. TELA API PLALTBENMODEL
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| MV_PLLAYAL | Define Layout Genérico Web que estará vinculado a API de alteração de Beneficiário para Analise. |
| BBA_MATRIC | Matricula do Beneficiário que irá atualizar os dados |
| B7L_CAMPO | Campo da tabela BA1 correspondente a alteração |
| B7L_VLPOS | Novo valor do campo da tabela BA1 informado no B7L_CAMPO. |
| MV_PLURDOW | Diretório web para salvar os arquivos recebidos via API do produto TOTVS Saúde Planos. |
05. TABELAS UTILIZADAS
- BBA - Cabeçalho Solic. Beneficiarios
- B2N - Inclusão de Beneficiários
- BA1 - Cadastro de Beneficiários
- BA3 - Família
- B90 - Layout Pag. Web
- B91 - Campos Layout
- ACB - Bancos de Conhecimentos
- AC9 - Relação de Objetos x Entidades
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas