01. DADOS GERAIS

02. EXEMPLO DE UTILIZAÇÃO

Ao incluir um ou mais beneficiários através do endpoint PLIncAutoBenModel, tornou-se necessário gravar os opcionais.

Durante o processamento de criação de um beneficiário, os opcionais são automaticamente vinculados ao seu cadastro, considerando as seguintes situações:

Pessoa Jurídica

Para que a gravação ocorra corretamente:

• O plano (produto no cadastro de produtos) que possui os opcionais vinculados deve estar associado ao subcontrato.
• O código do plano (produto) deve ser informado na propriedade B2N_CODPRO no body da requisição, que será refletido no campo BA1_CODPLA no cadastro de beneficiários

Pessoa Física

Para que a gravação ocorra corretamente:

• O plano (produto no cadastro de produtos) deve estar configurado com os opcionais vinculados.
• O código do plano (produto) deve ser informado na propriedade B2N_CODPRO no body da requisição, que será refletido no campo BA1_CODPLA no cadastro de beneficiários.

Parâmetro de Controle – MV_PLCAROP

A gravação dos opcionais é controlada pelo parâmetro MV_PLCAROP, que pode assumir os seguintes valores:

Quando houver a gravação de um ou mais opcionais, o response do endpoint exibirá uma seção identificada pelo ID DETAILOPC quando a inclusão de um ou mais beneficiários ocorrer com sucesso.

Essa seção conterá as seguintes propriedades principais:

• MATRICULA - Matrícula do beneficiário ao qual os opcionais foram vinculados.
• RESULT - Resultado da gravação.

A propriedade RESULT retorna uma string em formato JSON, contendo os detalhes da operação.

Estrutura do JSON na Propriedade RESULT

O JSON retornado em RESULT possui as seguintes propriedades:

• product - Código do opcional (cadastrado como produto no cadastro de produtos) para o qual foi realizada a tentativa de gravação.
• version - Versão do opcional.
• response - Objeto que representa o resultado da tentativa de gravação do opcional, contendo:

• • success: indica se a gravação foi bem-sucedida.
    • true → gravação realizada com sucesso.
    • false → gravação não realizada.
  • message: em caso de falha (success = false), retorna o possível motivo da não gravação.

{
   "id": "DETAILOPC",
   "modeltype": "GRID",
   "optional": 1,
   "struct": [
       {
            "id": "MATRICULA",
            "order": 1
       },
       {
            "id": "RESULT",
            "order": 2
       }
   ],
   "items": [
       {
            "id": 1,
            "deleted": 0,
            "fields": [
                {
                    "id": "MATRICULA",
                    "value": "00010001000152008"
                },
                {
                    "id": "RESULT",
                    "value": "[{\"product\":\"9896\",\"version\":\"001\",\"response\":{\"success\":true,\"message\":\"\"}},{\"product\":\"9897\",\"version\":\"001\",\"response\":                       					\"success\":true,\"message\":\"\"}}]"
                }
            ]
       },
       {
            "id": 2,
            "deleted": 0,
            "fields": [
                {
                    "id": "MATRICULA",
                    "value": "00010001000152016"
                },
                {
                    "id": "RESULT",
                    "value": "[{\"product\":\"9896\",\"version\":\"001\",\"response\":{\"success\":true,\"message\":\"\"}},{\"product\":\"9897\",\"version\":\"001\",\"response\":{\"success\":true,\"message\":\"\"}}]"
               }
           ]
       }
    ]
}

04. DEMAIS INFORMAÇÕES

Não se aplica.

05. ASSUNTOS RELACIONADOS

Para informações detalhadas sobre o funcionamento do endpoint e o retorno relacionado aos opcionais, consulte a documentação oficial disponível no link abaixo:

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