Histórico da Página

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áriobeneficiá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)

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

...

Url

...

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

Parâmetros

SubscriberId (path)

String

Image Added	Número da carteirinha do beneficiário	*required
Authorization (header)

String

Image Added	Cabeçalho usado para autorização das requisições	*required
Content-

Type

Type (header)

String

Image Added

'application/json' é o formato do conteúdo

*required

...

Request

Sem BodyNão possui body!

...

Operação realizada com sucesso (200)

fields

Object

Image Added	Dados do beneficiário de acordo com a tabela BA1
fields.{campo do SX3}

String

Image Added

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.situationStringSituação atual do beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futurofields.cardStringCarteirinha do BeneficiáriostructArray

Estrutura dos fields de acordo com o dicionário de dados (SX3)

foldersArrayPastas do fields (Abas) de acordo com o dicionário de dados (SXA)

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 o dicionário de dados (SX3)
folders	Image Added	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

{
  "fields": {

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
  "fields": {
    "ba1_cpfusr": "23576483098",
    "ba1_drgusr": "",
    "ba1_nomusrcpfusr": "HERNANDES ALVES DA SILVA23576483098",
    "ba1_datnasdrgusr": "2001"",
    "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": "",
    "situationba1_nomsoc": "AtivoMARIA HERNANDES",
    "cardba3_codemp": "000110080000270101008",
  },
  "structba3_desemp": [
"EMPRESA    {VINICIUS TEIXEIRA",
      "field""ba3_conemp": "BA1_BAIRRO000000000001",
      "typeba3_vercon": "C001",
      "titleba3_subcon": "Bairro000000003",
      "descriptionba3_versub": "Bairro do Usuario001",
      "pictureba3_dessub": "@!SUBCONTRATO USO GERAL",
      "sizesituation": 20"Ativo",
      "decimalscard": 0,"00011008000027010"
      "cbox": []},
      "folderstruct": "1"
    },[
    {
      "field": "BA1BA3_COMENDCODEMP",
      "type": "C",
      "title": "ComplementoGrupo/Empr.",
      "description": "Complemento do EnderecoGrupo/Empresa",
      "picture": "@!",
      "size": 204,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "04"
    },
    {
      "field": "BA1BA3_ENDEREDESEMP",
      "type": "C",
      "title": "EndereçoDesc. Grupo",
      "description": "Endereco do UsuarioEmpresa",
      "picture": "@!",
      "size": 4025,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "05"
    },
    {
      "field": "BA1BA3_PAICONEMP",
      "type": "C",
      "title": "NomeContr. PaiEmpr.",
      "description": "NomeContrato do PaiEmpresa",
      "picture": "@!",
      "size": 3012,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "06"
    },
    {
      "field": "BA1BA3_ESTADOVERCON",
      "type": "C",
      "title": "EstadoVersão Cont.",
      "description": "EstadoVersao do UsuarioContrato",
      "picture": "@!",
      "size": 23,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "07"
    },
    {
      "field": "BA1BA3_MUNICISUBCON",
      "type": "C",
      "title": "MunicípioSub-Contrato",
      "description": "Municipio do UsuarioSub-Contrato",
      "picture": "@!",
      "size": 309,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "08"
    },
    {
      "field": "BA1BA3_MAEVERSUB",
      "type": "C",
      "title": "MãeVersão SubCo",
      "description": "Nome da MaeVersao Sub-Contrato",
      "picture": "@!",
      "size": 1203,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "09"
    },
    {
      "field": "BA1BA3_NOMUSRDESSUB",
      "type": "C",
      "title": "NomeDesc. UsuárioSub.",
      "description": "Nome do UsuarioDescricao Sub-Contrato",
      "picture": "@!",
      "size": 7040,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "10"
    },
    {
      "field": "BA1_DRGUSRCPFUSR",
      "type": "C",
      "title": "RGCPF",
      "description": "RGCPF do UsuarioUsuário",
      "picture": "@!",
   @R 999.999.999-99",
      "size": 11,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "11"
    },
    {
      "field": "BA1_CPFUSRDRGUSR",
      "type": "C",
      "title": "CPFRG",
      "description": "CPFRG do UsuárioUsuario",
      "picture": "@R 999.999.999-99@!",
      "size": 11,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "13"
    },
    {
      "field": "BA1_ESTCIVNOMUSR",
      "type": "C",
      "title": "EstadoNome CivilUsuário",
      "description": "EstadoNome Civildo Usuario",
      "picture": "@!",
      "size": 170,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "16"
    },
    {
      "field": "BA1_SEXODATNAS",
      "type": "CD",
      "title": "SexoDt. Nascto.",
      "description": "SexoData de Nascimento",
      "picture": "@!@D",
      "size": 18,
      "decimals": 0,
      "cbox": [
        {],
          "valuefolder": "1",
          "descriptionorder": "Masculino18"
    },
    },{
      "field": "BA1_SEXO",
   {
   "type": "C",
      "valuetitle": "2Sexo",
          "description": "FemininoSexo",
        }"picture": "@!",
        {"size": 1,
          "valuedecimals": "x"0,
          "descriptioncbox": "Anonimizado"[
        }{
      ],
      "foldervalue": "1"
    },
    {
      "fielddescription": "BA1_DATNASMasculino",
      "type": "D"  },
      "title": "Dt. Nascto.", {
          "descriptionvalue": "Data de Nascimento2",
          "picturedescription": "@DFeminino",
      "size": 8  },
       "decimals": 0,
 {
          "cboxvalue": []"x",
          "folderdescription": "1Anonimizado"
        },
    {  ],
      "fieldfolder": "BA1_MOTBLO1",
      "typeorder": "C20",
    },
  "title": "Motivo Bloq.", {
      "descriptionfield": "Motivo do BloqueioBA1_ESTCIV",
      "picturetype": "@!C",
      "sizetitle": "Estado 3Civil",
      "decimalsdescription": 0"Estado Civil",
      "cboxpicture": []"@!",
      "foldersize": "6"1,
    },
    {"decimals": 0,
      "fieldcbox": "BA1_DATBLO"[],
      "typefolder": "D1",
      "titleorder": "Data Bloq.23",
      "description": "Data do Bloqueio",},
    {
      "picturefield": "@DBA1_MAE",
      "sizetype": 8"C",
      "decimalstitle": 0"Mãe",
      "cboxdescription": [] "Nome da Mae",
      "folderpicture": "6@!",
    }
  ],
  "folderssize": [120,
    {
      "id": "1",
      "title": "Dados Pessoais"
    },  "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	Image Added	Código identificador do erro. (Tabela de Erros)
message	Image Added	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Added	Mensagem técnica e mais detalhada do erro.

Bloco de código

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

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

Image Added

Parâmetros

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

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

beneficiaries	Image Added	Beneficiários da Família
beneficiaries.card	Image Added	Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO
beneficiaries.name	Image Added	Nome do Beneficiário Campo: BA1_NOMUSR
beneficiaries.socialName	Image Added	Nome social do Beneficiário Campo: BA1_NOMSOC
beneficiaries.kinship	Image Added	Grau de Parentesco do Beneficiário Campo: BRP_DESCRI (Relacionamento pelo BA1_GRAUPA)
beneficiaries.situation	Image Added	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": [
    {
      "idcard": "300011008000027010",
      "titlename": "RelativosHERNANDES ALVES aoDA Plano"
    }SILVA",
    {
      "idsocialName": "4MARIA HERNANDES",
      "titlekinship": "Cobranca"
    },
    {
      "id": "5BENEFICIARIO TITULAR",
      "titlesituation": "AnsAtivo"
    },
    {
      "idcard": "600011008000027028",
      "titlename": "OutrosFABIANA SOPHIA MELO",
    },
    {"socialName": "",
      "idkinship": "7CONJUGE/ COMPANHEIRO",
      "titlesituation": "Regras de parcelamentoAtivo"
    }
  ]
}

...

Mensagens de Erros

code

String

Image Added

Código identificador do erro. (Tabela de

Erro

Erros)

*required

message

String

Image Added

Literal no idioma da requisição descrevendo o erro para o usuário.

*required

detailedMessage

String

Image Added

Mensagem técnica e mais detalhada do erro.

*required

Bloco de código

language	c#
theme	Midnight
title	Retorno API Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
}": "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

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Dados do Contrato

Endpoint

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

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Beneficiários da Família

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Tabela de Código de Erros

03. TELA DADOS DE CONTRATO

04. TELA DADOS DE CONTRATO

05. TABELAS UTILIZADAS

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Dados do Contrato

Endpoint

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

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Beneficiários da Família

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Tabela de Código de Erros

03. TELA DADOS DE CONTRATO

04. TELA DADOS DE CONTRATO

05. TABELAS UTILIZADAS

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