Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Layout Genérico Web
2. Get API PLINCBENMODELAPI
3. Post API PLINCBENMODELAPI
4. Put API PLINCBENMODEL
5. Delete API PLINCBENMODELAPI
Tela API PLINCBENMODELPLIncBenModel
1. Outras Ações / Ações relacionadas
Tela API PLINCBENMODELPLIncBenModel
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

Este documento tem como objetivo demonstrar a utilização da API PLINCBENMODEL PLIncBenModel, onde será realizada a solicitação de um novo protocolo de inclusão de titulares e dependentes.

...

A API utilizará o padrão REST.

02. EXEMPLO DE UTILIZAÇÃO

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.

...

A autenticação da API é realizado 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_PLLAYIN. Por exemplo: MV_PLLAYIN = PPLINCBEN, a api irá utilizar as configurações contidas nessa layout genérico.

...

Abaixo será apresentado um exemplo de cada método da API PLINCBENMODELPLIncBenModel.

GET API

...

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/fwmodel/PLINCBENMODELPLIncBenModel/[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 consulta consultar todos os protocolos.

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
    "total": 266,
    "count": 2,
    "startindex": 1,
    "resources": [
        {
            "id": "PLAltBenModel",
            "operation": 1,
            "pk": "TSBTUCAgICAwMDAwMDE=",
            "models": [
                {
                    "id": "MASTERBBA",
                    "modeltype": "FIELDS",
                    "fields": [
                        {
                            "id": "BBA_FILIAL",
                            "order": 1,
                            "value": "M SP"
                        },
                        {
                            "id": "BBA_CODSEQ",
                            "order": 2,
                            "value": "000001"
                        },
                        {
                            "id": "BBA_TIPSOL",
                            "order": 3,
                            "value": "2"
                        },
                        {
                            "id": "BBA_STATUS",
                            "order": 4,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CODINT",
                            "order": 5,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_CODEMP",
                            "order": 6,
                            "value": "1007"
                        },
                        {
                            "id": "BBA_CONEMP",
                            "order": 7,
                            "value": "000000000001"
                        },
                        {
                            "id": "BBA_VERCON",
                            "order": 8,
                            "value": "001"
                        },
                        {
                            "id": "BBA_SUBCON",
                            "order": 9,
                            "value": "000000001"
                        },
                        {
                            "id": "BBA_VERSUB",
                            "order": 10,
                            "value": "001"
                        },
                        {
                            "id": "BBA_MATRIC",
                            "order": 11,
                            "value": "00011007000001012"
                        },
                        {
                            "id": "BBA_CODPRO",
                            "order": 13,
                            "value": "0005"
                        },
                        {
                            "id": "BBA_DATSOL",
                            "order": 15,
                            "value": "20220222"
                        },
                        {
                            "id": "BBA_HORSOL",
                            "order": 16,
                            "value": "14:35"
                        },
                        {
                            "id": "BBA_NROPRO",
                            "order": 18,
                            "value": "41750520220222000001"
                        },
                        {
                            "id": "BBA_TIPMAN",
                            "order": 19,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CPFTIT",
                            "order": 20,
                            "value": "76461633090"
                        },
                        {
               				"id":"BBA_CODCLI",
               				"order":24,
               				"value":"000001"
            			},
            			{
             			  "id":"BBA_LOJA",
            			   "order":25,
			               "value":"01"
			            }
                     ]
                }
            ]
        },
        {
            "id": "PLAltBenModel",
            "operation": 1,
            "pk": "TSBTUCAgICAwMDAwMDM=",
            "models": [
                {
                    "id": "MASTERBBA",
                    "modeltype": "FIELDS",
                    "fields": [
                        {
                            "id": "BBA_FILIAL",
                            "order": 1,
                            "value": "M SP"
                        },
                        {
                            "id": "BBA_CODSEQ",
                            "order": 2,
                            "value": "000003"
                        },
                        {
                            "id": "BBA_TIPSOL",
                            "order": 3,
                            "value": "2"
                        },
                        {
                            "id": "BBA_STATUS",
                            "order": 4,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CODINT",
                            "order": 5,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_CODEMP",
                            "order": 6,
                            "value": "0022"
                        },
                        {
                            "id": "BBA_MATRIC",
                            "order": 11,
                            "value": "00010022000012012"
                        },
                        {
                            "id": "BBA_CODPRO",
                            "order": 13,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_DATSOL",
                            "order": 15,
                            "value": "20220310"
                        },
                        {
                            "id": "BBA_HORSOL",
                            "order": 16,
                            "value": "08:46"
                        },
                        {
                            "id": "BBA_NROPRO",
                            "order": 18,
                            "value": "41750520220310000003"
                        },
                        {
                            "id": "BBA_TIPMAN",
                            "order": 19,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CPFTIT",
                            "order": 20,
                            "value": "42655436423"
                        }
                    ]
                }
            ]
        }
    ]
}

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

{
    "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/PLINCBENMODELPLIncBenModel/	POST	application/json	Realiza a inclusão de um novo protocolo na analise de beneficiários

Parâmetros de Entrada do Método

Sim

Parâmetro (fields)	Obrigatório	Tipo	Descrição
BBA_CODINT	Sim	Caracter	Código da Operadora (BA0) do Beneficiário
BBA_CODEMP	Sim	Caracter	Código da Empresa (BG9) do Beneficiário
BBA_CONEMP	Não	Caracter	Código do Contrato (BT5) do Beneficiário, Obrigatório em Empresa Jurídica.
BBA_VERCON	Não	Caracter	Versão do Contrato do Beneficiário, Obrigatório em Empresa Jurídica.
BBA_SUBCON	Não	Caracter	Código do SubContrato (BQC) do Beneficiário, Obrigatório em Empresa Jurídica.
BBA_VERSUB	Não	Caracter	Versão do SubContrato do Beneficiário, Obrigatório em Empresa Jurídica.
BBA_EMPBEN	Sim	Caracter	Nome do Beneficiário Titular.
BBA_CODPRO	Sim	Caracter	Código do Plano do Beneficiário Titular.
BBA_VERSAO	Sim	Caracter	Versão do Plano do Beneficiário Titular
BBA_CPFTIT	Sim	Caracter	CPF do Beneficiário Titular.
BBA_NROPRO	Não	Caracter	Numero do Protocolo, caso não seja informado o sistema irá gerar automaticamente um numero.
BBA_MATRIC	Não	Caracter	Matricula do titular ou responsável familiar, esse campo é utilizado quando for incluir um beneficiário em uma família já existente, caso seja uma nova família, o mesmo não deverá ser preenchido.
BBA_CODCLI	Não	Caracter	Código referente ao registro do Cadastro de Cliente (SA1).
BBA_LOJA	Não	Caracter	Código da loja referente ao registro do Cadastro de Cliente (SA1).

B2N_NOMUSR	Sim	Caracter	Nome do Beneficiário
B2N_DATNAS	Sim	Caracter	Data de Nascimento do Beneficiário
B2N_GRAUPA	Sim	Caracter	Código do Grau de parentesco (BRP)
B2N_ESTCIV	Sim	Caracter	Código do estado civil com base no SX5 tabela 33
B2N_SEXO	Sim	Caracter	Sexo do Beneficiário, sendo 1 para Masculino e 2 para Feminino.
B2N_CPFUSR	Não	Caracter	CPF do Beneficiário, Sendo obrigatório para beneficiário titular (independentemente de idade) ou beneficiário dependente com idade igual ou superior a 18 anos.
B2N_DRGUSR	Não	Caracter	RG do Beneficiário.
B2N_ORGEM	Não	Caracter	Org. Emissor.
B2N_RGEST	Não	Caracter	Estado Emissor.
B2N_NRCRNA	Não	Caracter	Numero da Carteira nacional de saúde.
B2N_CEPUSR	Não	Caracter	CEP do Beneficiário (Tabela BC9).
B2N_ENDERE	Não	Caracter	Endereço do Beneficiário.
B2N_NR_END	Não	Caracter	Numero do Endereço do Beneficiário.
B2N_COMEND	Não	Caracter	Complemento do Endereço do Beneficiário.
B2N_UNIVER	Não	Caracter	Informa se o Beneficiário é Universitário. Sendo 1 pra Sim e 0 pra Não.
B2N_BAIRRO	Não	Caracter	Bairro do Beneficiário
B2N_EMAIL	Não	Caracter	E-mail do Beneficiário.
B2N_CODMUN	Não	Caracter	Código do Município (Tabela BID).
B2N_INVALI	Não	Caracter	Invalidez?, sendo 1 pra sim e 0 pra não;
B2N_MUNICI	Não	Caracter	Descrição do Município.
B2N_ESTADO	Não	Caracter	Estado.
B2N_TELEFO	Não	Caracter	Telefone do Beneficiário
B2N_DDD	Não	Caracter	DDD do Telefone.
B2N_MAE	Não	Caracter	Nome Mãe do Beneficiário (Será obrigatório caso se o campo BQC_INFANS esteja igual a "1 - Sim").
B2N_PAI	Não	Caracter	Nome do Pai do Beneficiário.
B2N_COMUNI	Não	Caracter	Preferência de Comunicação: 0 para E-mail, 1 para SMS e 2 para Ambos
B2N_BANCO	Não	Caracter	Código do Banco (Tabela SA6).
B2N_AGENC	Não	Caracter	Agência correspondente ao Banco.
B2N_CONTA	Não	Caracter	Numero da Conta correspondente a Agência.
B2N_DATADT	Não	Caracter	Data de adoção do Beneficiário
B2N_CODPRO	Não	Caracter	Codigo do Plano do Beneficiário, caso não seja informado o sistema irá utilizar o do títular (BBA_CODPRO).

DIRECTORY	Não	Caracter	Diretório http do arquivo para anexar ao protocolo de inclusã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

Inclusão de uma família completa, com titular e dependente:

...

Bloco de código

language	c#
theme	Midnight
title	Request body - Inclusão de um dependente em uma família já existente
linenumbers	true
collapse	true

{
   "id":"PLIncBenModel",
   "operation":3,
   "models":[
      {
         "id":"MASTERBBA",
         "modeltype":"FIELDS",
         "fields":[
            {
               "id":"BBA_MATRIC",
               "order":1,
               "value":"00011008000019017"
            }
         ],
         "models":[
            {
               "id":"DETAILB2N",
               "modeltype":"GRID",
               "items":[
                  {
                     "id":1,
                     "deleted":0,
                     "fields":[
                        {
                           "id":"B2N_NOMUSR",
                           "value":"BENEFICIARIO DEPENDENTE"
                        },
                        {
                           "id":"B2N_DATNAS",
                           "value":"19750217"
                        },
                        {
                           "id":"B2N_GRAUPA",
                           "value":"03"
                        },
                        {
                           "id":"B2N_ESTCIV",
                           "value":"C"
                        },
                        {
                           "id":"B2N_SEXO",
                           "value":"1"
                        },
                        {
                           "id":"B2N_CPFUSR",
                           "value":"89631553663"
                        },
                        {
                           "id":"B2N_DRGUSR",
                           "value":"490643784"
                        },
                        {
                           "id":"B2N_ORGEM",
                           "value":"SSP"
                        },
                        {
                           "id":"B2N_RGEST",
                           "value":"SP"
                        },
                        {
                           "id":"B2N_CEPUSR",
                           "value":"57490000"
                        },
                        {
                           "id":"B2N_ENDERE",
                           "value":"RUA DE ALAGOAS"
                        },
                        {
                           "id":"B2N_NR_END",
                           "value":"1140"
                        },
                        {
                           "id":"B2N_COMEND",
                           "value":"APTO 52"
                        },
                        {
                           "id":"B2N_BAIRRO",
                           "value":"CENTRO SUL"
                        },
                        {
                           "id":"B2N_EMAIL",
                           "value":"[email protected]"
                        },
                        {
                           "id":"B2N_CODMUN",
                           "value":"2700102"
                        },
                        {
                           "id":"B2N_MUNICI",
                           "value":"AGUA BRANCA"
                        },
                        {
                           "id":"B2N_ESTADO",
                           "value":"AL"
                        },
                        {
                           "id":"B2N_TELEFO",
                           "value":"81993910031"
                        },
                        {
                           "id":"B2N_DDD",
                           "value":"081"
                        },
                        {
                           "id":"B2N_MAE",
                           "value":"MAE DO DEPENDENTE"
                        },
                        {
                           "id":"B2N_PAI",
                           "value":"PAI DO DEPENDENTE"
                        },
                        {
                           "id":"B2N_CODPRO",
                           "value":"0001"
                        }
                     ]
                  }
               ]
            },
            {
                "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": "COMPROVANTE_TESTE_01"
                            }
                        ]
                    }
                ]
            }
         ]
      }
   ]
}

PUT API

...

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/fwmodel/PLINCBENMODELPLIncBenModel/[pk]	PUT	application/json	Realiza a alteração de um protocolo de inclusão 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.

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á 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.

DELETE API

...

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/fwmodel/PLINCBENMODELPLIncBenModel/[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).

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

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

{
    "errorCode": 400,
    "errorMessage": "\r\n --- Erro no Modelo ---\r\nId submodelo origem:[]\r\nId campo origem:[]\r\nId submodelo erro: [PLIncBenModel]\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 PLINCBENMODEL

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica	Não se aplica.

04. TELA API PLINCBENMODEL

Principais Campos e Parâmetros

Campo	Descrição
MV_PLLAYIN	Define Layout Genérico Web que estará vinculado a API de inclusão de Beneficiário para Analise.
BBA_MATRIC	Matricula do Titular ou responsável familiar quando for realizada a inclusão de dependentes na família, quando realizada a inclusão de uma nova família essa campo não deverá ser preenchido
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
BRP - Graus de Parentesco
SA6 - Bancos
BC9 - CEPs
BID - Municípios
B90 - Layout Pag. Web
B91 - Campos Layout
ACB - Bancos de Conhecimentos
AC9 - Relação de Objetos x Entidades
BG9 - Grupos Empresas
BQC - Subcontrato
BT6 - Empresa Contrato Produto
BI3 - Produtos de Saúde

Árvore de páginas

Versões comparadas

Versão antiga 17

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

LAYOUT GENÉRICO WEB

GET API

Endpoint

Parâmetros de Entrada do Método

Exemplo

POST API

Endpoint

Parâmetros de Entrada do Método

Exemplo

PUT API

Endpoint

Parâmetros de Entrada do Método

Exemplo

DELETE API

Endpoint

Parâmetros de Entrada do Método

Exemplo

03. TELA API PLINCBENMODEL

04. TELA API PLINCBENMODEL

05. TABELAS UTILIZADAS