Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Dados do Contrato
2. Beneficiários da Família
3. Tabela de Código de Erro
Tela Dados de Contrato
1. Outras Ações / Ações relacionadas
Tela Dados de Contrato
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

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 Gestão do Beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)

Clique aqui para detalhes sobre como habilitar o serviço de APIs

02. EXEMPLO DE UTILIZAÇÃO

Dados do Contrato

Retorna os dados de contrato do beneficiário (Tabela BA1).

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/contract

Parâmetros

SubscriberId (path)	Número da carteirinha do beneficiário	*required
Authorization (header)	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	'application/json' é o formato do conteúdo	*required

Request

Não possui body!

Operação realizada com sucesso (200)

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 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		Situação atual do beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro Campo: BA1_DATBLO
fields.card		Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO
struct		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)

{
  "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",
      "picture": "@!",
      "size": 40,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "10"
    },
    {
      "field": "BA1_CPFUSR",
      "type": "C",
      "title": "CPF",
      "description": "CPF do Usuário",
      "picture": "@R 999.999.999-99",
      "size": 11,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "11"
    },
    {
      "field": "BA1_DRGUSR",
      "type": "C",
      "title": "RG",
      "description": "RG do Usuario",
      "picture": "@!",
      "size": 11,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "13"
    },
    {
      "field": "BA1_NOMUSR",
      "type": "C",
      "title": "Nome Usuário",
      "description": "Nome do Usuario",
      "picture": "@!",
      "size": 70,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "16"
    },
    {
      "field": "BA1_DATNAS",
      "type": "D",
      "title": "Dt. Nascto.",
      "description": "Data de Nascimento",
      "picture": "@D",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "18"
    },
    {
      "field": "BA1_SEXO",
      "type": "C",
      "title": "Sexo",
      "description": "Sexo",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Masculino"
        },
        {
          "value": "2",
          "description": "Feminino"
        },
        {
          "value": "x",
          "description": "Anonimizado"
        }
      ],
      "folder": "1",
      "order": "20"
    },
    {
      "field": "BA1_ESTCIV",
      "type": "C",
      "title": "Estado Civil",
      "description": "Estado Civil",
      "picture": "@!",
      "size": 1,
      "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_ENDERE",
      "type": "C",
      "title": "Endereço",
      "description": "Endereco do Usuario",
      "picture": "@!",
      "size": 40,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "41"
    },
    {
      "field": "BA1_COMEND",
      "type": "C",
      "title": "Complemento",
      "description": "Complemento do Endereco",
      "picture": "@!",
      "size": 20,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "43"
    },
    {
      "field": "BA1_BAIRRO",
      "type": "C",
      "title": "Bairro",
      "description": "Bairro do Usuario",
      "picture": "@!",
      "size": 20,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "44"
    },
    {
      "field": "BA1_MUNICI",
      "type": "C",
      "title": "Município",
      "description": "Municipio do Usuario",
      "picture": "@!",
      "size": 30,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "46"
    },
    {
      "field": "BA1_ESTADO",
      "type": "C",
      "title": "Estado",
      "description": "Estado do Usuario",
      "picture": "@!",
      "size": 2,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "47"
    },
    {
      "field": "BA1_PAI",
      "type": "C",
      "title": "Nome Pai",
      "description": "Nome do Pai",
      "picture": "@!",
      "size": 30,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "53"
    },
    {
      "field": "BA1_NOMSOC",
      "type": "C",
      "title": "Nome Social",
      "description": "Nome Social",
      "picture": "@!",
      "size": 50,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "BZ"
    },
    {
      "field": "BA1_DATBLO",
      "type": "D",
      "title": "Data Bloq.",
      "description": "Data do Bloqueio",
      "picture": "@D",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "6",
      "order": "68"
    },
    {
      "field": "BA1_MOTBLO",
      "type": "C",
      "title": "Motivo Bloq.",
      "description": "Motivo do Bloqueio",
      "picture": "@!",
      "size": 3,
      "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.

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
}

Beneficiários da Família

Retorna todos os beneficiários pertencente a família.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/familyBeneficiaries

Parâmetros

SubscriberId (path)	Número da carteirinha do beneficiário	*required
Authorization (header)	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	'application/json' é o formato do conteúdo	*required

Request

Não possui body!

Operação realizada com sucesso (200)

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

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

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
}

Tabela de Código de Erros

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

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

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica.	Não se aplica.

04. TELA DADOS DE CONTRATO

Principais Campos e Parâmetros

Campo	Descrição
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO	Carteirinha do Beneficiário

05. TABELAS UTILIZADAS

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