Histórico da Página

...

Retorna os beneficiários da pesquisa informado.

Endpoint

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

Image Modified

Parâmetros

Authorization (header)	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	'application/json' é o formato do conteúdo	*required
key (query)	Chave de pesquisa dos beneficiários, sendo: Nome Carteirinha CPF	*required
page (query)	Paginação da Coleção
pageSize (query)	Quantidade de Itens por Página
order (query)	Ordenação da Coleção
fields (query)	Filtrando campos de registros
filter (query)	Indica o filtro querystring recebido (pode se utilizar um filtro oData)

...

Operação realizada com sucesso (200)

beneficiaries	Image Modified	Beneficiários encontrados na pesquisa
beneficiaries.card	Image Modified	Carteirinha do beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO
beneficiaries.name	Image Modified	Nome do beneficiário Campo: BA1_NOMUSR
beneficiaries.type	Image Modified	Tipo do beneficiário, sendo: T (Titular), D (Dependente) e A (Agregado) Campo: BA1_TIPUSU
beneficiaries.kinship	Image Modified	Grau de parentesco do beneficiário Campo: BRP_DESCRI (Relacionamento pelo BA1_GRAUPA)
beneficiaries.situation	Image Modified	Situação atual do beneficiário, sendo: Ativo, Bloqueado ou Bloqueio Futuro Campo: BA1_DATBLO
hasNext	Image Modified	Indica se ainda existem registros a serem retornados
remainingRecords	Image Modified	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
}

...

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão 7

Chave

Endpoint

Parâmetros

Operação realizada com sucesso (200)