Histórico da Página

CONTEÚDO

Introdução
Exemplo de utilização
Tela XXX
1. Outras Ações / Ações relacionadas
Tela XXXPrincipais Campos e ParâmetrosEndpoint
Tabelas utilizadas

01. INTRODUÇÃO

...

Estado

subtle	true
colour	Blue
title	GET

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/card

03.

...

Outras Ações / Ações relacionadas

...

PARÂMETROS

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
healthInsurerCode (query)	string	Código da operadora (BA1_CODINT)	*required
login-user (query)	string	Filtro de beneficiários pelo usuário de login do portal (BSW_LOGUSR)
allFamily (query)	string	Define se será retornado todos os beneficiários do login, quando utilizado o query param loginUser, sendo: 0 - Não 1 - Sim
companyCode (query)	string	Filtro de beneficiários por empresa (BA1_CODEMP)
contractcode (query)	string	Filtro de beneficiários por contrato (BA1_CONEMP)
contractVersionCode (query)	string	Filtro de beneficiários por versão do contrato (BA1_VERCON)
subcontractCode (query)	string	Filtro de beneficiários por subcontrato (BA1_SUBCON)
subcontractVersioncode (query)	string	Filtro de beneficiários por versão do subcontrato (BA1_VERSUB)
familycode (query)	string	Filtro de beneficiários por código da família (BA1_MATRIC)
name (query)	string	Filtro de beneficiários por nome
socialName (query)	string	Filtro de beneficiários por nome social
beneficiaryType (query)	string	Filtro de beneficiários por tipo (BA1_TIPUSU), sendo: T - Titular D - Dependente A - Agregado
situation (query)	string	Filtro de beneficiários por situação, sendo: 1 - Ativo 2 - Inclusão futura 3 - Bloqueio futuro 4 - Bloqueado
subscriberId (query)	string	Filtro de beneficiários pela carteirinha (BA1_CODINT+BA1_CODEMP+BA1_TIPREG+BA1_DIGITO)
subscriberIdOrCpf	string	Filtro de beneficiários pela carteirinha ou cpf
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Nome	Tipo	Descrição
subscriberId (Path)	string	Identificador único da carteirinha do beneficiário. Obrigatório
Authorization (Header)	string	Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>. Obrigatório

04. RESPOSTA

200 - OK

Retorna os dados da carteirinha do beneficiário, incluindo informações pessoais, planos de saúde, imagens do cartão e configurações de layout.

Exemplo de resposta:

04. TELA XXXXX

Principais Campos e Parâmetros

...

Card documentosInformacaoUse esse box para destacar informações relevantes e/ou de destaque.TituloIMPORTANTE!

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave