Histórico da Página
...
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.
...
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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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"
}
]
}
]
}
]
} |
...
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 | SimNã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.
...
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
https://<url>:<porta>/rest/fwmodel/PLIncBenModel/[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.
...
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/PLIncBenModel/[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). |
...
| 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
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas