Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Produto:

TOTVS Saúde Planos

Linha de Produto:

Linha Protheus

Segmento:

Saúde

Módulo:Plano de Saúde
Função:PLIncAutoBenModel
País:Brasil
Ticket:

21912320

Issue:DSAUBE-28233

02. 

...

EXEMPLO DE UTILIZAÇÃO

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

03. SOLUÇÃO

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

...

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


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

Estrutura do JSON em 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.


Bloco de código
languagec#
themeMidnight
titleRetorno API - dos Opcionais
linenumberstrue
collapsetrue
{
   "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\":\"\"}}]"
               }
           ]
       }
    ]
}

...