API PLIncAutoBenModel - Protocolo de Inclusão de Beneficiários Aprovado Automaticamente

CONTEÚDO

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

01. VISÃO GERAL

Este documento tem como objetivo demonstrar a utilização da API PLIncAutoBenModel, 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) sendo aprovados automaticamente pelo sistema, ou seja, será incluído um novo Grupo/Familiar para os beneficiários ou inclusão de beneficiários em uma família já existente.

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.

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.

Além disso, a API poderá receber alguns filtros (QueryStrings) no headers da requisição, como:

Key	Descrição
COUNT	Quantidade de registro que devem ser retornados (padrão: 10)
STARTINDEX	Indica a partir que qual index deverá ser retornado (padrão: 1)
FILTER	Filtro que será aplicado no método SetFilter()
FIELDDETAIL	Habilita mostrar mais informações nos campos do modelo (padrão: 10)
FIELDVIRTUAL	Habilita o retorno de campos virtuais (padrão: false)
FIELDEMPTY	Habilita o retorno de campos sem valores (padrão: false)
FIRSTLEVEL	Habilita o retorno dos sub modelos (padrão: true)
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
DEBUG	Valor booleano para habilitar o modo debug (padrão: false)
CACHE	Indica se sera feito cache do total de registros por alias, refere-se ao valor do total no retorno (padrão: true)
INTERNALID	Indica se deve retornar o ID(Recno) como informação complementar das linhas do GRID (padrão: false)

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.

FWRestModel

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.

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.

Pelo Layout o sistema irá utilizar as seguintes regras no modelo de dados para inclusão de beneficiários:

Campos que não permite edição: B91_EDITAR igual a .F.
Inicializador padrão dos campos: B91_INIPAD com expressão em advpl para inicializar o campo.
Validação dos campos: B91_VALID com expressão em advpl para validar o campo.
Campos obrigatórios: B91_OBRIGA igual a .T.

Caso o parâmetro esteja em branco, o sistema irá seguir com as regra do padrão.

Importante

O Layout utilizado na API, deverá utilizar exclusivamente a tabela B2N.

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

GET API

Endpoint

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

Request body

API Retorno - Sucesso

{
    "total": 16,
    "count": 2,
    "startindex": 1,
    "resources": [
        {
            "id": "PLIncBenModel",
            "operation": 1,
            "pk": "TSBTUCAgICAwMDAyMDc=",
            "models": [
                {
                    "id": "MASTERBBA",
                    "modeltype": "FIELDS",
                    "fields": [
                        {
                            "id": "BBA_FILIAL",
                            "order": 1,
                            "value": "M SP"
                        },
                        {
                            "id": "BBA_CODSEQ",
                            "order": 2,
                            "value": "000207"
                        },
                        {
                            "id": "BBA_TIPSOL",
                            "order": 3,
                            "value": "2"
                        },
                        {
                            "id": "BBA_STATUS",
                            "order": 4,
                            "value": "7"
                        },
                        {
                            "id": "BBA_CODINT",
                            "order": 5,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_CODEMP",
                            "order": 6,
                            "value": "1008"
                        },
                        {
                            "id": "BBA_CONEMP",
                            "order": 7,
                            "value": "000000000001"
                        },
                        {
                            "id": "BBA_VERCON",
                            "order": 8,
                            "value": "001"
                        },
                        {
                            "id": "BBA_SUBCON",
                            "order": 9,
                            "value": "000000003"
                        },
                        {
                            "id": "BBA_VERSUB",
                            "order": 10,
                            "value": "001"
                        },
                        {
                            "id": "BBA_EMPBEN",
                            "order": 12,
                            "value": "BENEFICIARIO TITULAR GERADO ADVPR"
                        },
                        {
                            "id": "BBA_CODPRO",
                            "order": 13,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_VERSAO",
                            "order": 14,
                            "value": "001"
                        },
                        {
                            "id": "BBA_DATSOL",
                            "order": 15,
                            "value": "20230202"
                        },
                        {
                            "id": "BBA_HORSOL",
                            "order": 16,
                            "value": "17:37"
                        },
                        {
                            "id": "BBA_NROPRO",
                            "order": 18,
                            "value": "41750520230202000207"
                        },
                        {
                            "id": "BBA_TIPMAN",
                            "order": 19,
                            "value": "1"
                        },
                        {
                            "id": "BBA_CPFTIT",
                            "order": 20,
                            "value": "26218848906"
                        }
                    ]
                }
            ]
        },
        {
            "id": "PLIncBenModel",
            "operation": 1,
            "pk": "TSBTUCAgICAwMDAyMDg=",
            "models": [
                {
                    "id": "MASTERBBA",
                    "modeltype": "FIELDS",
                    "fields": [
                        {
                            "id": "BBA_FILIAL",
                            "order": 1,
                            "value": "M SP"
                        },
                        {
                            "id": "BBA_CODSEQ",
                            "order": 2,
                            "value": "000208"
                        },
                        {
                            "id": "BBA_TIPSOL",
                            "order": 3,
                            "value": "2"
                        },
                        {
                            "id": "BBA_STATUS",
                            "order": 4,
                            "value": "7"
                        },
                        {
                            "id": "BBA_CODINT",
                            "order": 5,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_CODEMP",
                            "order": 6,
                            "value": "1008"
                        },
                        {
                            "id": "BBA_CONEMP",
                            "order": 7,
                            "value": "000000000001"
                        },
                        {
                            "id": "BBA_VERCON",
                            "order": 8,
                            "value": "001"
                        },
                        {
                            "id": "BBA_SUBCON",
                            "order": 9,
                            "value": "000000003"
                        },
                        {
                            "id": "BBA_VERSUB",
                            "order": 10,
                            "value": "001"
                        },
                        {
                            "id": "BBA_EMPBEN",
                            "order": 12,
                            "value": "BENEFICIARIO TITULAR GERADO ADVPR"
                        },
                        {
                            "id": "BBA_CODPRO",
                            "order": 13,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_VERSAO",
                            "order": 14,
                            "value": "001"
                        },
                        {
                            "id": "BBA_DATSOL",
                            "order": 15,
                            "value": "20230202"
                        },
                        {
                            "id": "BBA_HORSOL",
                            "order": 16,
                            "value": "17:46"
                        },
                        {
                            "id": "BBA_NROPRO",
                            "order": 18,
                            "value": "41750520230202000208"
                        },
                        {
                            "id": "BBA_TIPMAN",
                            "order": 19,
                            "value": "1"
                        },
                        {
                            "id": "BBA_CPFTIT",
                            "order": 20,
                            "value": "26218848906"
                        }
                    ]
                }
            ]
        }
    ]
}

Retorno API - Falha

{
    "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/PLIncAutoBenModel/	POST	application/json	Realiza a inclusão de um novo protocolo na analise de beneficiários, com a aprovação automática dos beneficiários para o Grupo/Familiar.

Parâmetros de Entrada do Método

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.

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	Sim	Caracter	Nome Mãe do Beneficiário.
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:

Importante: Quando realizado a inclusão de um titular, os dados dele na B2N deverá ser os mesmo da BBA (BBA_CPFTIT, BBA_EMPBEN, BBA_CODPRO).

Request body

{
   "id":"PLIncBenModel",
   "operation":3,
   "models":[
      {
         "id":"MASTERBBA",
         "modeltype":"FIELDS",
         "fields":[
            {
               "id":"BBA_CODINT",
               "order":1,
               "value":"0001"
            },
            {
               "id":"BBA_CODEMP",
               "order":2,
               "value":"1008"
            },
            {
               "id":"BBA_CONEMP",
               "order":3,
               "value":"000000000001"
            },
            {
               "id":"BBA_VERCON",
               "order":4,
               "value":"001"
            },
            {
               "id":"BBA_SUBCON",
               "order":5,
               "value":"000000005"
            },
            {
               "id":"BBA_VERSUB",
               "order":6,
               "value":"001"
            },
            {
               "id":"BBA_EMPBEN",
               "order":7,
               "value":"NOME BENEFICIARIO TITULAR"
            },
            {
               "id":"BBA_CODPRO",
               "order":8,
               "value":"0001"
            },
            {
               "id":"BBA_VERSAO",
               "order":9,
               "value":"001"
            },
            {
               "id":"BBA_CPFTIT",
               "order":10,
               "value":"48273995496"
            }
         ],
         "models":[
            {
               "id":"DETAILB2N",
               "modeltype":"GRID",
               "items":[
                  {
                     "id":1,
                     "deleted":0,
                     "fields":[
                        {
                           "id":"B2N_NOMUSR",
                           "value":"NOME BENEFICIARIO TITULAR"
                        },
                        {
                           "id":"B2N_DATNAS",
                           "value":"19560523"
                        },
                        {
                           "id":"B2N_GRAUPA",
                           "value":"01"
                        },
                        {
                           "id":"B2N_ESTCIV",
                           "value":"C"
                        },
                        {
                           "id":"B2N_SEXO",
                           "value":"2"
                        },
                        {
                           "id":"B2N_CPFUSR",
                           "value":"48273995496"
                        },
                        {
                           "id":"B2N_DRGUSR",
                           "value":"446430211"
                        },
                        {
                           "id":"B2N_ORGEM",
                           "value":"SSP"
                        },
                        {
                           "id":"B2N_RGEST",
                           "value":"SP"
                        },
                        {
                           "id":"B2N_CEPUSR",
                           "value":"57490000"
                        },
                        {
                           "id":"B2N_ENDERE",
                           "value":"TESTE"
                        },
                        {
                           "id":"B2N_NR_END",
                           "value":"1140"
                        },
                        {
                           "id":"B2N_COMEND",
                           "value":"APTO 22"
                        },
                        {
                           "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":"21993595175"
                        },
                        {
                           "id":"B2N_DDD",
                           "value":"021"
                        },
                        {
                           "id":"B2N_MAE",
                           "value":"MAE DO BENEFICIARIO TITULAR"
                        },
                        {
                           "id":"B2N_PAI",
                           "value":"PAI DO BENEFICIARIO TITULAR"
                        },
                        {
                           "id":"B2N_CODPRO",
                           "value":"0001"
                        }                
                     ]
                  },
                  {
                     "id":2,
                     "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_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://img.freepik.com/fotos-gratis/3d-rendem-de-uma-mesa-de-madeira-com-uma-imagem-defocussed-de-um-barco-em-um-lago_1048-3432.jpg?w=2000"
                            },
                            {
                                "id": "FILENAME",
                                "value": "COMPROVANTE_TESTE"
                            }
                        ]
                    }
                ]
            }
         ]
      }
   ]
}

Ao solicitar um POST com sucesso, o mesmo irá retornar o protocolo como se tivesse realizado um GET com a pk correspondente ao protocolo.

API Retorno - Sucesso

{
    "id": "PLIncBenModel",
    "operation": 1,
    "pk": "TSBTUCAgICAwMDAyMzg=",
    "models": [
        {
            "id": "MASTERBBA",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "BBA_FILIAL",
                    "order": 1,
                    "value": "M SP"
                },
                {
                    "id": "BBA_CODSEQ",
                    "order": 2,
                    "value": "000238"
                },
                {
                    "id": "BBA_TIPSOL",
                    "order": 3,
                    "value": "2"
                },
                {
                    "id": "BBA_STATUS",
                    "order": 4,
                    "value": "7"
                },
                {
                    "id": "BBA_CODINT",
                    "order": 5,
                    "value": "0001"
                },
                {
                    "id": "BBA_CODEMP",
                    "order": 6,
                    "value": "1008"
                },
                {
                    "id": "BBA_CONEMP",
                    "order": 7,
                    "value": "000000000001"
                },
                {
                    "id": "BBA_VERCON",
                    "order": 8,
                    "value": "001"
                },
                {
                    "id": "BBA_SUBCON",
                    "order": 9,
                    "value": "000000005"
                },
                {
                    "id": "BBA_VERSUB",
                    "order": 10,
                    "value": "001"
                },
                {
                    "id": "BBA_EMPBEN",
                    "order": 12,
                    "value": "NOME BENEFICIARIO TITULAR"
                },
                {
                    "id": "BBA_CODPRO",
                    "order": 13,
                    "value": "0001"
                },
                {
                    "id": "BBA_VERSAO",
                    "order": 14,
                    "value": "001"
                },
                {
                    "id": "BBA_DATSOL",
                    "order": 15,
                    "value": "20230203"
                },
                {
                    "id": "BBA_HORSOL",
                    "order": 16,
                    "value": "17:06"
                },
                {
                    "id": "BBA_NROPRO",
                    "order": 18,
                    "value": "41750520230203000238"
                },
                {
                    "id": "BBA_TIPMAN",
                    "order": 19,
                    "value": "1"
                },
                {
                    "id": "BBA_CPFTIT",
                    "order": 20,
                    "value": "48273995496"
                }
            ],
            "models": [
                {
                    "id": "DETAILB2N",
                    "modeltype": "GRID",
                    "struct": [
                        {
                            "id": "B2N_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "B2N_STATUS",
                            "order": 2
                        },
                        {
                            "id": "B2N_PROTOC",
                            "order": 3
                        },
                        {
                            "id": "B2N_NOMUSR",
                            "order": 4
                        },
                        {
                            "id": "B2N_FLGCTR",
                            "order": 5
                        },
                        {
                            "id": "B2N_TIPUSU",
                            "order": 6
                        },
                        {
                            "id": "B2N_DATNAS",
                            "order": 7
                        },
                        {
                            "id": "B2N_GRAUPA",
                            "order": 8
                        },
                        {
                            "id": "B2N_ESTCIV",
                            "order": 10
                        },
                        {
                            "id": "B2N_SEXO",
                            "order": 11
                        },
                        {
                            "id": "B2N_CPFUSR",
                            "order": 12
                        },
                        {
                            "id": "B2N_DRGUSR",
                            "order": 13
                        },
                        {
                            "id": "B2N_ORGEM",
                            "order": 14
                        },
                        {
                            "id": "B2N_RGEST",
                            "order": 15
                        },
                        {
                            "id": "B2N_NRCRNA",
                            "order": 16
                        },
                        {
                            "id": "B2N_CEPUSR",
                            "order": 17
                        },
                        {
                            "id": "B2N_ENDERE",
                            "order": 18
                        },
                        {
                            "id": "B2N_NR_END",
                            "order": 19
                        },
                        {
                            "id": "B2N_COMEND",
                            "order": 20
                        },
                        {
                            "id": "B2N_UNIVER",
                            "order": 21
                        },
                        {
                            "id": "B2N_BAIRRO",
                            "order": 22
                        },
                        {
                            "id": "B2N_EMAIL",
                            "order": 23
                        },
                        {
                            "id": "B2N_CODMUN",
                            "order": 24
                        },
                        {
                            "id": "B2N_INVALI",
                            "order": 25
                        },
                        {
                            "id": "B2N_MUNICI",
                            "order": 26
                        },
                        {
                            "id": "B2N_DATOBI",
                            "order": 27
                        },
                        {
                            "id": "B2N_ESTADO",
                            "order": 28
                        },
                        {
                            "id": "B2N_TELEFO",
                            "order": 29
                        },
                        {
                            "id": "B2N_DDD",
                            "order": 30
                        },
                        {
                            "id": "B2N_MAE",
                            "order": 31
                        },
                        {
                            "id": "B2N_PAI",
                            "order": 32
                        },
                        {
                            "id": "B2N_COMUNI",
                            "order": 33
                        },
                        {
                            "id": "B2N_BANCO",
                            "order": 34
                        },
                        {
                            "id": "B2N_AGENC",
                            "order": 35
                        },
                        {
                            "id": "B2N_CONTA",
                            "order": 36
                        },
                        {
                            "id": "B2N_DATADT",
                            "order": 37
                        },
                        {
                            "id": "B2N_CODMOT",
                            "order": 38
                        },
                        {
                            "id": "B2N_CODSEQ",
                            "order": 40
                        },
                        {
                            "id": "B2N_BA1REC",
                            "order": 41
                        },
                        {
                            "id": "B2N_CODEMP",
                            "order": 42
                        },
                        {
                            "id": "B2N_CONEMP",
                            "order": 43
                        },
                        {
                            "id": "B2N_SUBCON",
                            "order": 44
                        },
                        {
                            "id": "B2N_CODPRO",
                            "order": 45
                        },
                        {
                            "id": "B2N_DTBLOQ",
                            "order": 46
                        },
                        {
                            "id": "B2N_TIPBLO",
                            "order": 47
                        },
                        {
                            "id": "B2N_MATGRF",
                            "order": 48
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "B2N_FILIAL",
                                    "value": "M SP"
                                },
                                {
                                    "id": "B2N_STATUS",
                                    "value": "2"
                                },
                                {
                                    "id": "B2N_PROTOC",
                                    "value": "000238"
                                },
                                {
                                    "id": "B2N_NOMUSR",
                                    "value": "NOME BENEFICIARIO TITULAR"
                                },
                                {
                                    "id": "B2N_FLGCTR",
                                    "value": "1"
                                },
                                {
                                    "id": "B2N_TIPUSU",
                                    "value": "T"
                                },
                                {
                                    "id": "B2N_DATNAS",
                                    "value": "19560523"
                                },
                                {
                                    "id": "B2N_GRAUPA",
                                    "value": "01"
                                },
                                {
                                    "id": "B2N_ESTCIV",
                                    "value": "C"
                                },
                                {
                                    "id": "B2N_SEXO",
                                    "value": "2"
                                },
                                {
                                    "id": "B2N_CPFUSR",
                                    "value": "48273995496"
                                },
                                {
                                    "id": "B2N_DRGUSR",
                                    "value": "446430211"
                                },
                                {
                                    "id": "B2N_ORGEM",
                                    "value": "SSP"
                                },
                                {
                                    "id": "B2N_RGEST",
                                    "value": "SP"
                                },
                                {
                                    "id": "B2N_CEPUSR",
                                    "value": "57490000"
                                },
                                {
                                    "id": "B2N_ENDERE",
                                    "value": "TESTE"
                                },
                                {
                                    "id": "B2N_NR_END",
                                    "value": "1140"
                                },
                                {
                                    "id": "B2N_COMEND",
                                    "value": "APTO 22"
                                },
                                {
                                    "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": "21993595175"
                                },
                                {
                                    "id": "B2N_DDD",
                                    "value": "021"
                                },
                                {
                                    "id": "B2N_MAE",
                                    "value": "MAE DO BENEFICIARIO TITULAR"
                                },
                                {
                                    "id": "B2N_PAI",
                                    "value": "PAI DO BENEFICIARIO TITULAR"
                                },
                                {
                                    "id": "B2N_CODSEQ",
                                    "value": "000274"
                                },
                                {
                                    "id": "B2N_CODEMP",
                                    "value": "1008"
                                },
                                {
                                    "id": "B2N_CONEMP",
                                    "value": "000000000001"
                                },
                                {
                                    "id": "B2N_SUBCON",
                                    "value": "000000005"
                                },
                                {
                                    "id": "B2N_CODPRO",
                                    "value": "0001"
                                },
                                {
                                    "id": "B2N_MATGRF",
                                    "value": "00011008000059000"
                                }
                            ]
                        },
                        {
                            "id": 2,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "B2N_FILIAL",
                                    "value": "M SP"
                                },
                                {
                                    "id": "B2N_STATUS",
                                    "value": "2"
                                },
                                {
                                    "id": "B2N_PROTOC",
                                    "value": "000238"
                                },
                                {
                                    "id": "B2N_NOMUSR",
                                    "value": "BENEFICIARIO DEPENDENTE"
                                },
                                {
                                    "id": "B2N_FLGCTR",
                                    "value": "1"
                                },
                                {
                                    "id": "B2N_TIPUSU",
                                    "value": "D"
                                },
                                {
                                    "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_MAE",
                                    "value": "MAE DO DEPENDENTE"
                                },
                                {
                                    "id": "B2N_PAI",
                                    "value": "PAI DO DEPENDENTE"
                                },
                                {
                                    "id": "B2N_CODSEQ",
                                    "value": "000275"
                                },
                                {
                                    "id": "B2N_CODEMP",
                                    "value": "1008"
                                },
                                {
                                    "id": "B2N_CONEMP",
                                    "value": "000000000001"
                                },
                                {
                                    "id": "B2N_SUBCON",
                                    "value": "000000005"
                                },
                                {
                                    "id": "B2N_CODPRO",
                                    "value": "0001"
                                },
                                {
                                    "id": "B2N_MATGRF",
                                    "value": "00011008000059019"
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "DETAILANEXO",
                    "modeltype": "GRID",
                    "optional": 1,
                    "struct": [
                        {
                            "id": "CODSEQ",
                            "order": 1
                        },
                        {
                            "id": "DIRECTORY",
                            "order": 2
                        },
                        {
                            "id": "FILENAME",
                            "order": 3
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "CODSEQ",
                                    "value": "000238"
                                },
                                {
                                    "id": "DIRECTORY",
                                    "value": "COMPROVANTE_TESTE.JPG"
                                },
                                {
                                    "id": "FILENAME",
                                    "value": "COMPROVANTE_TESTE"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Retorno API - Falha

{
    "errorCode": 400,
    "errorMessage": "\r\n --- Erro no Modelo ---\r\nId submodelo origem:[DETAILB2N]\r\nId campo origem:[VLDDATA_POST]\r\nId submodelo erro: [DETAILB2N]\r\nId campo erro: []\r\nId erro: [VALID     ]\r\nMensagem de erro: [ O campo 	  (B2N_NOMUSR) não foi preenchido.[Item: 1]]\r\nMensagem da solução: [\r\n]\r\nValor atribuído: []\r\nValor anterior: []\r\n"
}

Request body - Inclusão de um dependente em uma família já existente

{
   "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"
                            }
                        ]
                    }
                ]
            }
         ]
      }
   ]
}

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

API PLIncAutoBenModel - Protocolo de Inclusão de Beneficiários Aprovado Automaticamente

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

03. TELA API PLINCBENMODEL

04. TELA API PLINCBENMODEL

05. TABELAS UTILIZADAS