Histórico da Página

...

Este documento tem como objetivo demonstrar a utilização dos endpoints dos dados de contrato do beneficiários, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).

/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/contract
/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/familyBeneficiaries

Esses endpoints são utilizados na nova tela de posição Gestão do beneficiárioBeneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)

...

fields		Dados do beneficiário de acordo com a tabela BA1
fields.{campo do SX3}		Os campos retornados da tabela BA1: ba1_cpfusr ba1_drgusr ba1_nomusr ba1_datnas ba1_sexo ba1_estciv ba1_mae ba1_endere ba1_comend ba1_bairro ba1_munici ba1_estado ba1_pai ba1_datblo ba1_motblo	fields.situation	Image Removed	Situação atual do beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro Campo: BA1_DATBLO	fields.card	Image Removed	Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO	ba1_nomsoc ba3_codemp (Tipo do Contrato Pessoa Jurídica) ba3_desemp (Tipo do Contrato Pessoa Jurídica) ba3_conemp (Tipo do Contrato Pessoa Jurídica) ba3_vercon (Tipo do Contrato Pessoa Jurídica) ba3_subcon (Tipo do Contrato Pessoa Jurídica) ba3_versub (Tipo do Contrato Pessoa Jurídica) ba3_dessub (Tipo do Contrato Pessoa Jurídica)
fields.situation	Image Added	Situação atual do beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro Campo: BA1_DATBLO
fields.card	Image Added	Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO
struct	Image Added	Estrutura dos fields de acordo com	struct	Image Removed	Estrutura dos fields de acordo com o dicionário de dados (SX3)
folders		Pastas do fields (Abas) de acordo com o dicionário de dados (SXA)

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso
linenumbers	true
collapse	true
- Sucesso
linenumbers	true
collapse	true

{
  "fields": {
    "ba1_cpfusr": "23576483098",
    "ba1_drgusr": "",
    "ba1_nomusr": "HERNANDES ALVES DA SILVA",
    "ba1_datnas": "2001-06-15",
    "ba1_sexo": "1",
    "ba1_estciv": "Solteiro(a)",
    "ba1_mae": "TESTE",
    "ba1_endere": "",
    "ba1_comend": "",
    "ba1_bairro": "",
    "ba1_munici": "",
    "ba1_estado": "",
    "ba1_pai": "",
    "ba1_datblo": "",
    "ba1_motblo": "",
    "ba1_nomsoc": "MARIA HERNANDES",
    "ba3_codemp": "1008",
    "ba3_desemp": "EMPRESA VINICIUS TEIXEIRA",
    "ba3_conemp": "000000000001",
    "ba3_vercon": "001",
    "ba3_subcon": "000000003",
    "ba3_versub": "001",
    "ba3_dessub": "SUBCONTRATO USO GERAL",
    "situation": "Ativo",
    "card": "00011008000027010"
  },
  "struct": [
    {
      "field": "BA3_CODEMP",
      "type": "C",
      "title": "Grupo/Empr.",
      "description": "Grupo/Empresa",
      "picture": "@!",
      "size": 4,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "04"
    },
    {
      "field": "BA3_DESEMP",
      "type": "C",
      "title": "Desc. Grupo",
      "description": "Empresa",
      "picture": "@!",
      "size": 25,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "05"
    },
    {
      "field": "BA3_CONEMP",
      "type": "C",
      "title": "Contr. Empr.",
      "description": "Contrato Empresa",
      "picture": "@!",
      "size": 12,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "06"
    },
    {
      "field": "BA3_VERCON",
      "type": "C",
      "title": "Versão Cont.",
      "description": "Versao Contrato",
      "picture": "@!",
      "size": 3,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "07"
    },
    {
      "field": "BA3_SUBCON",
      "type": "C",
      "title": "Sub-Contrato",
      "description": "Sub-Contrato",
      "picture": "@!",
      "size": 9,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "08"
    },
    {
      "field": "BA3_VERSUB",
      "type": "C",
      "title": "Versão SubCo",
      "description": "Versao Sub-Contrato",
      "picture": "@!",
      "size": 3,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "09"
    },
    {
      "field": "BA3_DESSUB",
      "type": "C",
      "title": "Desc. Sub.",
      "description": "Descricao Sub-Contrato{
  "fields": {
    "ba1_cpfusr": "23576483098",
      "ba1_drgusrpicture": "@!",
      "ba1_nomusrsize": "HERNANDES ALVES DA SILVA" 40,
      "decimals": 0,
      "ba1_datnascbox": "2001-06-15"[],
      "ba1_sexofolder": "1",
      "ba1_estcivorder": "Solteiro(a)"10"
    },
    "ba1_mae": "TESTE",
{
      "ba1_enderefield": "BA1_CPFUSR",
      "ba1_comendtype": "C",
      "ba1_bairrotitle": "CPF",
      "ba1_municidescription": "CPF do Usuário",
      "ba1_estadopicture": "@R 999.999.999-99",
      "ba1_paisize": ""11,
      "ba1_datblodecimals": ""0,
      "ba1_motblocbox": ""[],
      "situationfolder": "Ativo1",
      "cardorder": "0001100800002701011"
    },
  "struct": [
    {
      "field": "BA1_BAIRRODRGUSR",
      "type": "C",
      "title": "BairroRG",
      "description": "BairroRG do Usuario",
      "picture": "@!",
      "size": 2011,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "13"
    },
    {
      "field": "BA1_COMENDNOMUSR",
      "type": "C",
      "title": "Nome Usuário"Complemento",
      "description": "ComplementoNome do EnderecoUsuario",
      "picture": "@!",
      "size": 2070,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "16"
    },
    {
      "field": "BA1_ENDEREDATNAS",
      "type": "CD",
      "title": "EndereçoDt. Nascto.",
      "description": "EnderecoData dode UsuarioNascimento",
      "picture": "@!@D",
      "size": 408,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "18"
    },
    {
      "field": "BA1_PAISEXO",
      "type": "C",
      "title": "Nome PaiSexo",
      "description": "Nome do PaiSexo",
      "picture": "@!",
      "size": 301,
      "decimals": 0,
      "cbox": []
        {
          "value": "1",
          "folderdescription": "1Masculino"
        },
        {
          "value": "2",
          "fielddescription": "BA1_ESTADOFeminino",
      "type": "C"  },
       "title": "Estado",
 {
          "descriptionvalue": "Estado do Usuariox",
          "picturedescription": "@!Anonimizado",
      "size": 2,  }
      "decimals": 0],
      "cboxfolder": []"1",
      "folderorder": "120"
    },
    {
      "field": "BA1_MUNICIESTCIV",
      "type": "C",
      "title": "MunicípioEstado Civil",
      "description": "MunicipioEstado do UsuarioCivil",
      "picture": "@!",
      "size": 301,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "23"
    },
    {
      "field": "BA1_MAE",
      "type": "C",
      "title": "Mãe",
      "description": "Nome da Mae",
      "picture": "@!",
      "size": 120,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "30"
    },
    {
      "field": "BA1_NOMUSRENDERE",
      "type": "C",
      "title": "Nome UsuárioEndereço",
      "description": "NomeEndereco do Usuario",
      "picture": "@!",
      "size": 7040,
      "decimals": 0,
      "cbox": 0[],
      "cboxfolder": []"1",
      "folderorder": "141"
    },
    {
      "field": "BA1_DRGUSRCOMEND",
      "type": "C",
      "title": "RGComplemento",
      "description": "RGComplemento do UsuarioEndereco",
      "picture": "@!",
      "size": 1120,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "43"
    },
    {
      "field": "BA1_CPFUSRBAIRRO",
      "type": "C",
      "title": "CPFBairro",
      "description": "CPFBairro do UsuárioUsuario",
      "picture": "@R 999.999.999-99@!",
      "size": 1120,
      "decimals": 0,
      "cbox": 0[],
      "cboxfolder": []"1",
      "folderorder": "144"
    },
    {
      "field": "BA1_ESTCIVMUNICI",
      "type": "C",
      "title": "Estado CivilMunicípio",
      "description": "EstadoMunicipio do CivilUsuario",
      "picture": "@!",
      "size": 130,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "46"
    },
    {
      "field": "BA1_SEXOESTADO",
      "type": "C",
      "title": "SexoEstado",
      "description": "SexoEstado do Usuario",
      "picture": "@!",
      "size": 12,
      "decimals": 0,
      "cbox": [
        {],
          "valuefolder": "1",
          "descriptionorder": "Masculino47"
        },
        {
          "valuefield": "2BA1_PAI",
          "descriptiontype": "FemininoC",
      "title": "Nome }Pai",
      "description": "Nome do {Pai",
          "valuepicture": "x@!",
      "size": 30,
      "descriptiondecimals": "Anonimizado"0,
      "cbox": [],
 }
      ]"folder": "1",
      "folderorder": "153"
    },
    {
      "field": "BA1_DATNASNOMSOC",
      "type": "DC",
      "title": "Dt.Nome Nascto.Social",
      "description": "DataNome de NascimentoSocial",
      "picture": "@D@!",
      "size": 850,
      "decimals": 0,
      "cbox": []": [],
      "folder": "1",
      "folderorder": "1BZ"
    },
    {
      "field": "BA1_MOTBLODATBLO",
      "type": "CD",
      "title": "MotivoData Bloq.",
      "description": "MotivoData do Bloqueio",
      "picture": "@!@D",
      "size": 38,
      "decimals": 0,
      "cbox": [],
      "folder": "6",
      "order": "68"
    },
    {
      "field": "BA1_DATBLOMOTBLO",
      "type": "DC",
      "title": "DataMotivo Bloq.",
      "description": "DataMotivo do Bloqueio",
      "picture": "@D@!",
      "size": 83,
      "decimals": 0,
      "cbox": [],
      "folder": "6",
      "order": "69"
    }
  ],
  "folders": [
    {
      "id": "1",
      "title": "Dados Pessoais"
    },
    {
      "id": "3",
      "title": "Relativos ao Plano"
    },
    {
      "id": "4",
      "title": "Cobranca"
    },
    {
      "id": "5",
      "title": "Ans"
    },
    {
      "id": "6",
      "title": "Outros"
    },
    {
      "id": "7",
      "title": "Regras de parcelamento"
    }
  ]
}

...

Mensagens de Erros

code		Código identificador do erro. (Tabela de Erros)
message		Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage		Mensagem técnica e mais detalhada do erro.

...

beneficiaries		Beneficiários da Família
beneficiaries.card		Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO
beneficiaries.name		Nome do Beneficiário Campo: BA1_NOMUSR
beneficiaries.socialName	Image Added	Nome social do Beneficiário Campo: BA1_NOMSOC
beneficiaries.kinship		Grau de Parentesco do Beneficiário Campo: BRP_DESCRI (Relacionamento pelo BA1_GRAUPA)
beneficiaries.situation		Situação atual do Beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro Campo: BA1_DATBLO

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso
linenumbers	true
collapse	true

{
  "beneficiaries": [
    {
      "card": "00011008000027010",
      "name": "HERNANDES ALVES DA SILVA",
      "socialName": "MARIA HERNANDES",
      "kinship": "BENEFICIARIO TITULAR",
      "situation": "Ativo"
    },
    {
      "card": "00011008000027028",
      "name": "FABIANA SOPHIA MELO",
      "socialName": "",
      "kinship": "CONJUGE/ COMPANHEIRO",
      "situation": "Ativo"
    }
  ]
}

...

Mensagens de Erros

code		Código identificador do erro. (Tabela de Erros)
message		Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage		Mensagem técnica e mais detalhada do erro.

...

Código de erros informado no Json de retorno com falha (404):

Code	message	detailedMessage	Status Code
E001	Beneficiário não encontrado.	Não foi encontrado nenhum beneficiário com a matricula {subscriberId}	404

03. TELA DADOS DE CONTRATO

...

BA1 - Beneficiários
BRP - Graus de Parentesco
BA3 - Famílias

Árvore de páginas

Versões comparadas

Versão antiga 16

Nova versão Atual

Chave

Mensagens de Erros

Mensagens de Erros

03. TELA DADOS DE CONTRATO