Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Pesquisa de Beneficiários
2. Tabela de Código de Erros
Tela Pesquisa de Beneficiários
1. Outras Ações / Ações relacionadas
Tela Pesquisa de Beneficiários
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

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

/beneficiaryPosition/{subscriberId}/search

Esse endpoint é utilizado na nova tela de posiçã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

...

Retorna os beneficiários da pesquisa informado.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/search

GET

Parâmetros

Authorization (header)

String

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

String

Image Added	'application/json' é o formato do conteúdo	*required
key (query)

String

Image Added

Chave de pesquisa dos beneficiários, sendo:

Nome
Carteirinha
CPF

*required

page (query)

Integer

Image Added	Paginação da Coleção
pageSize (query)

Integer

Image Added	Quantidade de Itens por Página
order (query)

String

Image Added	Ordenação da Coleção
fields (query)

String

Image Added	Filtrando campos de registros
filter (query)

String

Image Added

Indica o filtro querystring recebido (pode se utilizar um filtro oData)

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

beneficiaries

Array

Image Added	Beneficiários encontrados na pesquisa
beneficiaries.card

String

Image Added

Carteirinha do beneficiário

Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO

beneficiaries.name

String

Image Added

Nome do beneficiário

Campo: BA1_NOMUSR

beneficiaries.type

String

Image Added

Tipo do beneficiário, sendo: T (Titular), D (Dependente) e A (Agregado)

Campo: BA1_TIPUSU

beneficiaries.kinship

Array

Image Added

Grau de parentesco do beneficiário

Campo: BRP_DESCRI (Relacionamento pelo BA1_GRAUPA)

beneficiaries.situation

Array

Image Added	Situação atual do beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro
hasNext

Boolean

Image Added	Indica se ainda existem registros a serem retornados
remainingRecords

Integer

Image Added

Quantidade de registros ainda existem para retorno

Bloco de código

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

{
  "beneficiaries": [
    {
      "card": "00010094000004017",
      "name": "MARIANA SANTOS DA SILVA",
      "type": "T",
      "kinship": "BENEFICIARIO TITULAR",
      "situation": "Ativo"
    },
    {
      "card": "00011008000026021",
      "name": "JAQUELINE MARIANE ROSA SILVEIRA",
      "type": "D",
      "kinship": "FILHO",
      "situation": "Ativo"
    },
    {
      "card": "00011012000001019",
      "name": "MARIANA LARISSA MARIAH RAMOS",
      "type": "T",
      "kinship": "BENEFICIARIO TITULAR",
      "situation": "Ativo"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0
}

...

Dados Inválidos (404)

code

String

Image Added	Código identificador do erro. (Tabela de Erro)
message

String

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

String

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

Tabela de Código de Erros

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

Code	message	detailedMessage
E001	Nenhuma chave de busca informada.	Obrigatório informar no query param a chave (key) de busca do beneficiário.

03. TELA

...

PESQUISA DE BENEFICIÁRIOS

Outras Ações / Ações relacionadas

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

04.

...

TELA PESQUISA DE BENEFICIÁRIOS

Principais Campos e Parâmetros

Campo	Descrição

...


BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO	Carteirinha de pesquisa do beneficiário
BA1_NOMUSR	Nome de pesquisa do beneficiário
BA1_CPFUSR	CPF de pesquisa do beneficiário

...

05. TABELAS UTILIZADAS

BA1 - Beneficiários

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Dados Inválidos (404)

Tabela de Código de Erros

03. TELA

PESQUISA DE BENEFICIÁRIOS

04.

TELA PESQUISA DE BENEFICIÁRIOS

05. TABELAS UTILIZADAS