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).
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
Retorna os beneficiários da pesquisa informado.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/search |
|
| 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:
| *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) |
Não possui body!
beneficiaries |
| Beneficiários encontrados na pesquisa |
| 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.type |
| Tipo do beneficiário, sendo: T (Titular), D (Dependente) e A (Agregado) Campo: BA1_TIPUSU |
| 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 |
| hasNext |
| Indica se ainda existem registros a serem retornados |
| remainingRecords |
| Quantidade de registros ainda existem para retorno |
{
"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
} |
code |
| Código identificador do erro. (Tabela de Erro) |
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"
} |
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. |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica | Não se aplica |
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 |
